Document and comment c# codes with Visual Studio and XML [10 mn de lecture - paru le 5/11/2004 1:50:40 PM - Public : Débutant]

Auteur

David CHARVET Elève-Ingénieur Supinfo Paris Promotion SUPINFO 2006    Lui écrire    Tous les projets de cet auteur    Le mini-CV de cet auteur

1. Configuration and pre-required

1.1. Configure XML commenting

VS.net can generate a strutured XML file. With this file, it may be possible to create a documentation of yours codes in a variety of forms : html, MSDN... and « Intellisense » wich allow to see informations while placing the cursor on the code.

To benefit from these functions, XML support must be activate:

• In the solution explorer, right Click on the project and select "properties"
• In the properties dialog double click on the “Configuration Properties” node.
• In XML Documentation File, enter the xml name file.You can call the file what you like, but for compatibility with all the features of XML commenting, it should take the form of assembly name.