Delphi新注释
标准请看帮助⽂件⾥的：XML Documentation Comments
个⼈常⽤
1.
1. <summary></summary>：摘要
1. /// <summary>
/// 这是摘要
/// </summary>
2. <remarks></remarks>：描述
1. /// <remarks>
/// 这是描述
/
// </remarks>
3. <returns></returns>：返回
1. /// <returns>返回值</returns>
4. <param name=""></param>：参数的名称和描述
1. /// <param name="变量名">类型</param>
5. <see cref=""/>：形成类似超链接的效果，字下⾯有横线，但点了后不会跳转
1. /// <see cref="System.Classes.TPersistentClass"/>
6. <para></para>：新段落
1. ///  aa<para>bb</para>cc
7. <c></c>：⽤了这个后，英⽂看起来字体⼩了⼀号
1. ///  MyName1 <c>MyName2</c> MyName3
8. <code></code>：代码段，效果有点像 <para><c></c></para>
1. /// MyName1<code>MyName2</code>MyName3
⽹上抄录的
param nameXML注释分为⼀级注释（Primary Tags）和⼆级注释（Secondary Tags），前者可以单独存在，后者必须包含在⼀级注释内部。
1.
1. ⼀级注释
1. <remarks>对类型进⾏描述，功能类似<summary>，据说建议使⽤<remarks>
2. <summary>对共有类型的类、⽅法、属性或字段进⾏注释
3. <value>主要⽤于属性的注释，表⽰属性的制的含义，可以配合<summary>使⽤
4. <param>⽤于对⽅法的参数进⾏说明，格式：<param name="param_name">value</param>
5. <returns>⽤于定义⽅法的返回值，对于⼀个⽅法，输⼊///后，会⾃动添加<summary>、<param>列表和<returns>
6. <exception>定义可能抛出的异常，格式：<exception cref="IDNotFoundException">
7. <example>⽤于给出如何使⽤某个⽅法、属性或者字段的使⽤⽅法
8. <permission>涉及⽅法的访问许可
9. <seealso>⽤于参考某个其它的东东：），也可以通过cref设置属性
10. <include>⽤于指⽰外部的XML注释
2. ⼆级注释
1. <c> or <code>主要⽤于加⼊代码段
2. <para>的作⽤类似HTML中的<p>标记符，就是分段
3. <pararef>⽤于引⽤某个参数
4. <see>的作⽤类似<seealso>，可以指⽰其它的⽅法
5. <list>⽤于⽣成⼀个列表
XML中需要的转义字符
1.
1. &(逻辑与)  &
2. <(⼩于)    <
3. >(⼤于)    >
4. "(双引号)  "
5. '(单引号)  '
需要注意的是
1.
1. 转义序列各字符间不能有空格
2. 转义序列必须以";"结束
3. 单独的&不被认为是转义开始
4. 区分⼤⼩写
例⼦
/// <summary>
/// 对象池 ( ⽀持模板 )
/// </summary>
/// <remarks>
/// 这是⼀个对像池, 可以池化所有 TObject 对像 ( ⽀持模板 )
/// <code>
/// ⽤法:
/
// <para>在⼀个全局的地⽅定义: </para>
/// <para>var</para>
/// <para>  Pooler: TObjPool<；要收集的类名></para>
/// </code>
/// <code>
/// <para>⽤到的地⽅: </para>
/// <para>tmpObj := Pooler.LockObj as Txxx;</para>
/// <para>if Assigned(tmpObj) then</para>
/// <para>try</para>
/// <para>finally</para>
/// <para>  Pooler.UnlockObj(tmpObj);</para>
/
// <para>end;</para>
/// </code>
/// <code>
/// <para>初始化: </para>
/// <para>initialization</para>
/// <para>  Pooler := TObjPool<；要收集的类名>(对象池最⼤值, 对象池最⼩值).Create;</para> /// <para>finallization</para>
/// <para>  Pooler.Free;</para>
/// </code>
/// </remarks>

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。