background preloader

Documentation

Facebook Twitter

Igm.univ-mlv.fr/~cherrier/download/imac/Poo6.pdf. Untitled. Bien commenter et documenter son code en C# Compatible avec : La lecture de ce tutoriel ne requiert aucune connaissance particulière si ce n'est les bases de la programmation en C#.

Bien commenter et documenter son code en C#

Tout au long de ce tutoriel je m'efforcerai de faire la distinction entre ce qui est admis par tous et les règles que j'applique moi même. L'idée de ce tutoriel vient d'un sujet de discussion sur le forum. Je tiens également à préciser que les exemples de code sont volontairement simplistes et parfois un développeur expérimenté ne trouvera pas les commentaires pertinents; toutefois le tutoriel vise un public débutant. Tous les mots entre « » du tutoriel sont des tags de documentation. Commenter le code … Tout le monde en a entendu parler, les développeurs/chefs de projets/professeurs le disent tout le temps : « Commente ton code STP ».

Mais voilà, que faut-il commenter ? C'est à ces deux principales questions que je vais essayer de répondre. II-A. Assurément, il ne faut pas tout commenter dans un code. Exemple : II-B. À ce stade, deux choix sont possibles : Doxygen. Generate documentation from source code Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D.

Doxygen

Doxygen can help you in three ways: It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in ) from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.

Doxygen is developed under Mac OS X and Linux, but is set-up to be highly portable. Doxygen license Copyright © 1997-2013 by Dimitri van Heesch. User examples These are part of a larger list of projects that use doxygen. GhostDoc - Simplify your XML Comments! Simplify your XML Comments!

GhostDoc - Simplify your XML Comments!

Latest build: 4.9.14093 [New] Release date: April 3, 2014 Visual Studio 2013 Visual Studio 2012 Visual Studio 2010 Visual Studio 2008 GhostDoc is a Visual Studio extension that automatically generates XML documentation comments for methods and properties based on their type, parameters, name, and other contextual information. When generating documentation for class derived from a base class or for interface implementation (e.g. .NET Framework or your custom framework), GhostDoc will use the documentation that Microsoft or the framework vendor has already written for the base class or interface. Benefits Save keystrokes and time; simplify documenting your code Benefit of the base class documentation StyleCop compliant documentation templates XML Comment Preview (Pro) Code Spell Checker (Pro) Build Help File (Pro) Take control of your help files with Help Configurations and Template Libraries Introduction to GhostDoc (3 min) What's new New in version 4.9 Editions.