Search code examples
c#documentation-generation

How to correctly add documentation in my c# code (similar to javadoc)


Is there any native way of documenting my code in C#? Something similar to javadoc in java and different of doxygen or Sandcastle.


Solution

  • I'm not familiar with JavaDoc, but you can type /// above classes and methods in Visual Studio to generate summary code blocks. Further you can enable XML documentation in your project properties so that summary data is included in class libraries, Swagger auto-generated API documentation, etc.