BlackWaspTM
<< Previous | 1 | Next >>
Documenting ExceptionsDocumenting Exceptions
Code can be decorated with XML documentation comments, which can be compiled into documentation files. When members can throw exceptions, the comments can include a description of each expected exception and the reasons why it may be thrown.
Building Help Files with SandcastleBuilding Help Files with Sandcastle
XML documentation comments allow useful descriptive information to be attached to types and their members. This information is displayed within Visual Studio whilst coding but sometimes it is more useful to produce documentation as help files.
XML Documentation CommentsXML Documentation Comments
Documentation is important to ensure that developers can quickly learn and use code libraries. With XML documentation comments, the documentation can be embedded within source code using special mark-up that is recognised by Visual Studio's Intellisense.
<< Previous | 1 | Next >>