https://github.com/meir017/documentation-generator

Generate code examples for your C# API using your C# code
https://github.com/meir017/documentation-generator

Last synced: 17 days ago
JSON representation

Generate code examples for your C# API using your C# code

• Host: GitHub
• URL: https://github.com/meir017/documentation-generator
• Owner: Meir017
• License: mit
• Created: 2024-11-28T14:28:35.000Z (29 days ago)
• Default Branch: main
• Last Pushed: 2024-11-28T14:59:11.000Z (29 days ago)
• Last Synced: 2024-11-28T15:33:15.692Z (29 days ago)
• Language: C#
• Size: 14.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Documentation Generator

Generate code examples for your C# API using your C# code, this will ensure that your code examples in your documentation comments are valid.

⚠️ This is an idea for a tool, no implementation yet, Please share your feedback here https://github.com/Meir017/documentation-generator/discussions/1 ⚠️

The idea is to wrap the example code with `#region ID` and `#endregion`.

where the ID follows the format https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d42-id-string-format

for example - 

`MyClass.cs`:

```csharp

namespace MyService;

public class MyClass

{

    /// 

    /// method summary

    /// 

    /// this-will-be-generated

    /// 

    /// 

    /// ...

    /// 

    /// method summary

    /// 

    /// var result = theClass.MyMethod(1, 2);

    /// Assert.Equal(42, result);

    /// 

    /// 

    /// ...

    ///