Delphi新注释

• 标准请看帮助文件里的：XML Documentation Comments

• 个人常用

1. 1. ：摘要

      1. /// 
         
         /// 这是摘要
         /// 

   2. ：描述

      1. /// 
         /// 这是描述
         /// 

   3. ：返回

      1. /// 返回值

   4. ：参数的名称和描述

      1. /// 类型

   5. ：形成类似超链接的效果，字下面有横线，但点了后不会跳转

      1. /// 

   6. ：新段落

      1. ///  aabbcc

   7. ：用了这个后，英文看起来字体小了一号

      1. ///  MyName1 MyName2 MyName3

   8. ：代码段，效果有点像

      1. /// MyName1MyName2MyName3

• 网上抄录的

XML注释分为一级注释（Primary Tags）和二级注释（Secondary Tags），前者可以单独存在，后者必须包含在一级注释内部。

1. 1. 一级注释
      1. 对类型进行描述，功能类似
         ,据说建议使用
      2. 对共有类型的类、方法、属性或字段进行注释
      3. 主要用于属性的注释，表示属性的制的含义，可以配合
         使用
      4. 用于对方法的参数进行说明，格式：value
      5. 用于定义方法的返回值，对于一个方法，输入///后，会自动添加
         、列表和
      6. 定义可能抛出的异常，格式：
      7. 用于给出如何使用某个方法、属性或者字段的使用方法
      8. 涉及方法的访问许可
      9. 用于参考某个其它的东东：），也可以通过cref设置属性
      10. 用于指示外部的XML注释
   2. 二级注释
      1. or 主要用于加入代码段
      2. 的作用类似HTML中的

         标记符，就是分段

      3. 用于引用某个参数
      4. 的作用类似,可以指示其它的方法
      5. 用于生成一个列表

/// 

/// 对象池 ( 支持模板 )
/// 
/// 
/// 这是一个对像池, 可以池化所有 TObject 对像 ( 支持模板 )
/// 
/// 用法:
/// 在一个全局的地方定义: 
/// var
///   Pooler: TObjPool<要收集的类名>
/// 
/// 
/// 用到的地方: 
/// tmpObj := Pooler.LockObj as Txxx;
/// if Assigned(tmpObj) then
/// try
/// finally
///   Pooler.UnlockObj(tmpObj);
/// end;
/// 
/// 
/// 初始化: 
/// initialization
///   Pooler := TObjPool<要收集的类名>(对象池最大值, 对象池最小值).Create;
/// finallization
///   Pooler.Free;
/// 
///