Search

How to Use NDoc to Generate XML Documentation in .NET

2 views

Documentation of your system is one of the important tasks that has to be done for any software system or product. Without that it is not an easy to track the code and the features that are incorporated in the system. With proper documentation of your system it is possible to reduce the repeated work that is done without knowing what is there in your system. Instead of writing your own documentation by seeing the program logic it would be better if there is a tool to generate the documentation based on the comments that are given in the code. One such tool that is of more help to the developers is the NDoc. If you use NDoc properly you can document your system in a very good manner than documenting manually. Before you use the NDoc tool you have to ensure that it is installed in your system. Assuming that you are using the Visual Studio .Net for your development, you have to see whether you have the directory C:\Program Files\HTML Help Workshop in your system. If you do not have that directory in your C drive then download and install the HTML Help Workshop in your system. After you have that directory in place you can download the NDoc tool from the website sourceforge.net. You can search for the NDoc project in that site or download NDoc at / <summary> This program is used to find the page rank of the URL that is given in text box. <para> We are using the Google API to determine the page rank of the given url. </para> </summary> */ The <para> tag can be used within the summary tag is you want to break the comments in the summary tag as paragraphs. For giving any additional information you can use the <remarks> tag. Tags like <returns> are used before the methods for identifying the return type of the methods. The <param> tags are used to identify the parameters used in the methods. A tag called the <seealso> is used to redirect the user to some other definitions or part of the documentation. This is used as cross reference. For more details on the tags you can refer to DiggThis | Furl Stay current with the latest technology developments related to XML and other related technologies? Visit

Found an error or have a suggestion? Let us know and we'll review it.

Share this article

Comments (0)

Please sign in to leave a comment.

No comments yet. Be the first to comment!