ndoc – Tarik Billa

.NET xml docs – inheriting documentation

September 3, 2023 by Tarik

I have a better answer: FiXml. Cloning comments with GhostDoc is certainly working approach, but it has significant disadvantages, e.g.: When the original comment is changed (which frequently happens during development), its clone is not. You’re producing huge amount of duplicates. If you’re using any source code analysis tools (e.g. Duplicate Finder in Team City), … Read more

What Are Best Practices For Documenting C# code with XML comments?

August 12, 2023 by Tarik

In comments used to build API documentation, you should: Explain what the method or property does, why it exists at all, and explain any domain concepts that are not self-evident to the average consumer of your code. List all preconditions for your parameters (cannot be null, must be within a certain range, etc.) List any … Read more