Source Codes Documentation
How to document your source codes or assets.
Source Codes
Document the code following the C# documentation syntax. Every time that some new source codes are pushed to master branch, the new version of API documentation will be generated automagically.
Tip
You can use ///
(above a method or class) and your IDE will generate a documentation template for you (at least MS Visual Studio and JetBrains Rider do this, notepad probably not ;-).
You can add some specific articles - tutorials, descriptions, etc. for your source codes or modules. Documentation (including this file) is stored in Documentation
folder in the root folder of project. We are using the DocFX to translate raw markdown files into web pages.