Use documentation in comments to generate pages in wiki

[iegik]

1. https://github.com/SWY1985/CivOne/wiki
2. https://github.com/fire-eggs/CivOne/wiki
3. Documentation in comments

/// <summary>
/// Modify the unit attack strength.
/// </summary>
/// <param name="value">The new attack strength for the unit. (valid range: 0 to 99)</param>
public Attack(byte value) : base(typeof(byte), value, InRange)
{
}

There is a several plugins and tools that can compile comments in the code into reach documentation. We should try that.

For example, we can document interfaces

---

Related links:

• https://code.visualstudio.com/docs/languages/csharp
• https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/documentation-comments
• https://stackoverflow.com/questions/15316381/create-html-documentation-for-c-sharp-code
• https://github.com/neuecc/MarkdownGenerator
• https://stackoverflow.com/questions/60063974/how-can-i-generate-documentation-for-c-sharp-that-outputs-as-markdown-for-an-azu

[fire-eggs]

Related: issue #104

[iegik]

This issue mostly about two questions:

• Is there any plugin for vscode or simple way to add doc-in-code parts into code?
• Is there any (cross-platform) tool for generating Markdown documentation around code for our Wiki?

For example (pseudo code): docgen --prefix="API~" src/**/*.cs ../CivOne.wiki/API/ will generate pages like API/API~Settlers.md

[fire-eggs]

https://github.com/eneko/SourceDocs https://github.com/mkdocs/mkdocs/ https://dotnet.github.io/docfx/

https://marketplace.visualstudio.com/items?itemName=PeterMacej.VSdocman https://www.doxygen.nl/index.html