Document automation can be a strong tool for developers if used smartly and efficiently. Documenting their codes can help to get the project successfully completed. Unfortunately, documenting is the most distressing task for developers as they may want to complete the task with minimum bugs, keystrokes, and headaches.
If you can understand the importance of documenting the codes for making your project more understandable and indicative, you would certainly love the support feature of XML documentation in Visual Studio.Net framework. Document automation ensures that your classes are intelligible to yourself and of course to others as well. The XML file created in the process of documentation can also be referred as a simple guide for what has to be coded in the program.
When in the process of documentation, the created XML file can be converted into other understandable formats of MS Word, PDF or even HTML help files but all these facilities are available through third party. Some of the creative developers may want to use their own XSL stylesheets with their own desired design template and added features. If you too are among such line of developers, you can either write your own codes or you can change the template to befit your requirement.
Amending The Template
You can easily change the XSL file to fit your needs. Assuming that you already are familiar with the fundamental of HTML, the XSL file is typically divided in following four sections that can easily be identified in the file with uppercase comments:
1. Document Template: This section denotes the template for the whole HTML document. You can simply add <HEAD> section to add the link to another CSS style sheet.
2. Assembly Template: This template typically has the name of the assembly. This template is also responsible to call members template.
3. Members Template: This is the main template that does much of the work. It loops all through various types in XML document and it also displays their individual methods, properties and fields.
4. Other Templates: These templates of the style sheet formats individual tags as mentioned in the XML documentation in the form of basic HTML elements. This is the place where you can make changes to format tags in the desired manner. For example, if you want your summaries to appear in green, you can change the respective tag to match your needs.