Search code examples
.netdocumentationdocumentation-generation

custom documentation for C# code


Is there a customizable documentation generator for C#? As opposed to native xml documentation which provides documentations for classes, methods, properties, the documentation I am referring to here is more lower-level, ie it documents the flow of a method.

for example in the given code

void SomeMethod(){

///doc:Do X
SomeCodeToDoX

///doc:Do Y
SomeCodeToDoY

///not tagged
SomeCode

}

The documentation will capture doc:Do X and doc:Do Y, and will document Do X and Do Y as the flow inside the method SomeMethod

**I hope I made the question clear enough.. if I didn't please comment to ask clarification*


Solution

  • Don't know if this answers your question, but you can use SandCastle: http://sandcastle.codeplex.com/

    It creates MSDN documentation by reflecting assemblies. You can (but not required) add your own documentation tags too.