Visual C++ .NET/Development/Document

Материал из .Net Framework эксперт
Перейти к: навигация, поиск

A bullet list

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <summary> 
       /// A bullet list
       /// <list type="bullet">
       ///   <item> bullet </item>
       ///   <item> bullet </item>
       /// </list>
       /// </summary>
       void listTag() {}
   }
  
 </source>


A definition of terms

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <summary> 
       /// A definition of terms
       /// <list type="table">
       ///   <listheader>
       ///     <term>Properties</term>
       ///     <description>Initial Value</description>
       ///   </listheader>
       ///   <item>
       ///     <term>term1 name</term>
       ///     <description>term1 description</description>
       ///   </item>
       ///   <item>
       ///     <term>term2 name</term>
       ///     <description>term2 description</description>
       ///   </item>
       ///   <item>
       ///     <term>termN name</term>
       ///     <description>termN description</description>
       ///   </item>
       /// </list>
       /// </summary>
       void listTag() {}
   }
  
 </source>


A numbered list

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <summary> 
       /// A numbered list
       /// <list type="number">
       ///   <item> entry 1 </item>
       ///   <item> entry 2 </item>
       ///   <item> entry n </item>
       /// </list>
       /// </summary>
       void listTag() {}
   }
  
 </source>


A table

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <summary> 
       /// A table
       /// <list type="table">
       ///   <item>
       ///     <description>row 1 -- column a</description>
       ///     <description>row 1 -- column b</description>
       ///     <description>row 1 -- column c</description>
       ///   </item>
       ///   <item>
       ///     <description>row 2 -- column a</description>
       ///     <description>row 2 -- column b</description>
       ///     <description>row 2 -- column c</description>
       ///   </item>
       /// </list>
       /// </summary>
       void listTag() {}
   }
  
 </source>


Example code tag

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <example>
       ///   <para> Example summary </para>
       ///    
       ///   Visual Basic .NET code example
       ///   
   ///   
       ///   C# code example
       ///   
       ///   
       ///   C++ code example
       ///   
       /// </example>
       void exampleTag() {}
   }
  
 </source>


Include tag

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <summary> 
       /// <summary> This is a summary with an <include> tag containing 
       ///    a <list type="bullet">
       ///    <include file="document.xml" path="AllDoc/Entry[@num="1"]/*" />
       /// </summary>
       /// <include file="document.xml" path="AllDoc/Entry[@num="2"]/*" />
       /// </summary>
       void includeTag() {}
   }
  
 </source>


paramref tag

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <summary> This summary reference the <paramref name="param1"/> 
       /// parameter of the method
       /// </summary>
       void paramrefTag(int param1) {}
   }
  
 </source>


Property value tag

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <value> valueTag property has a value of double</value>
       property double valueTag
       {
           double get() {return 0.0;}
           void set(double val) {}
       }
   }
  
 </source>


Remark tag

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <remarks> 
       /// This is a remarks tag for the remarksTag() method 
       /// </remarks>
       void remarksTag() {}
   }
  
 </source>


See also tag

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <summary>
       /// The basic see tag <see cref="File" />
       /// The enhanced see tag <see cref="FileInfo">System::IO:FileInfo</see>
       /// </summary>
       void seeTag() {}
   }
  
 </source>


Summary Tag

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <summary> 
       /// This is a summary tag for the summaryTag() method 
       /// </summary>
       void summaryTag() {}
   }
  
 </source>


Using code tag to insert code

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <example>
       /// Some code in an example tag
       ///  
       ///   A code statement;
       ///   Another code statement;
       /// 
       /// </example>
       void codeTag() {}
   }
  
 </source>


Using c tag to insert code

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <summary> 
       /// Some <c>Program code</c> in a summary 
       /// </summary>
       void cTag() {}
   }
  
 </source>


Using exception Tag to describe the exception

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <exception cref="System::OverflowException"> 
       /// This method might throw this exception (NOT)
       /// </exception> 
       void exceptionTag() {}
   }
  
 </source>


Using paragraph tag to insert large chunk of comments

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <summary> 
       /// <para>This is the first paragraph which spans more than one line 
       /// when the document window is small enough.</para><para>This is the 
       /// next paragraph which started in a new line.</para>
       /// </summary>
       void paraTag() {}
   }
  
 </source>


Using param tag to add comments for the parameters

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <param name="param1">The first int parameter</param>
       /// <param name="param2">The second String^ parameter</param>
       void paramTag(int param1, String ^param2) {}
   }
  
 </source>


Using permission Tag to tell the permission

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <permission cref="System::Security::PermissionSet">
       ///   Go ahead anyone can access me.
       /// </permission>
       void permissionTag() {}
   }
  
 </source>


Using return tag to add comments for returning value

<source lang="csharp">

   public ref class AClass
   {
   public:
       /// <returns> returnsTag returns an int </returns>
       int returnsTag() {return 0;}
   }
  
 </source>