latest release v1.5.9 - last update 14 Feb 2011 |
XMLコマンドDoxygen supports most of the XML commands that are typically used in C# code comments. The XML tags are defined in Appendix E of the ECMA-334 standard, which defines the C# language. Unfortunately, the specification is not very precise and a number of the examples given are of poor quality. Here is the list of tags supported by doxygen:
Here is an example of a typical piece of code using some of the above commands: /// <summary> /// A search engine. /// </summary> class Engine { /// <summary> /// The Search method takes a series of parameters to specify the search criterion /// and returns a dataset containing the result set. /// </summary> /// <param name="connectionString">the connection string to connect to the /// database holding the content to search</param> /// <param name="maxRows">The maximum number of rows to /// return in the result set</param> /// <param name="searchString">The text that we are searching for</param> /// <returns>A DataSet instance containing the matching rows. It contains a maximum /// number of rows specified by the maxRows parameter</returns> public DataSet Search(string connectionString, int maxRows, int searchString) { DataSet ds = new DataSet(); return ds; } } |
|
This page was last modified on 14 Feb 2011.
© 1997-2010 Dimitri van Heesch, first release 27 oct 1997.
© 2001 OKA Toshiyuki (Japanese translation). © 2006-2011 TSUJI Takahiro (Japanese translation). © 2006-2011 TAKAGI Nobuhisa (Japanese translation). |