Visual Studio / monodevelop have awesome feature that can let you specify xml comments above every function / variable which is then displayed as a description of that function when you roll over it, click it etc.
/// <summary>
/// This is example for stack overflow
/// </summary>
public void Foo()
{
}
This is cool, but it works only in your local code (within 1 project) how can I make these comments that are in functions in external library, which is referenced in another project, available in THAT project as well? It should be possible, because it works for .Net assemblies (when you reference a .Net library, you will be able to see these descriptions for functions in that library)
You can generate the xml for documentation of your library using visual studio, check it here.
The Generate XML documentation file property determines whether an XML file will be generated during compilation. You set this property on the Compile page (for Visual Basic) or Build page (for Visual C#) of the Project Designer. When this option is selected, XML documentation is automatically emitted into an XML file, which will have the same name as your project and the .xml extension, Reference.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With