我想问一下各位高手关于XML注释的问题。一、如何对于一个**.cs文件进行注释?例如:
/// <summary>
/// ベース30値及びサブモードを保存するアレイを定義するファイル
/// (c) NEC Soft Co.,Ltd.
/// </summary>
using System;
namespace Necsoft.BarcodeStudio.TD
{
     internal class _CodeWord
{
  ………………
}
}这样写正确吗?二、对于一个函数进行注释后函数中的成员变量该如何注释,风格是什么?例如:
/// <summary>
/// pInfoInで与えられた情報より元にコード語を生成する関数
/// </summary>
/// …………
internal int PDF417_MakeCodeWord(ref PDF417_INFO_IN pInfoIn)
{
    int nCount = 0;
}
对于int nCount = 0 是该用///……这种风格注释呢,还是用/// <summary>……</summary>这种风格注释呢?
感谢各位高手解答!!

解决方案 »

  1.   

    对文件的注释没有定义,因为XML文档注释是提供给Assembly,或者说是dll及exe的注释,仅描述其中的类型和公共成员。
    对internal或者private的类型和成员,没有必要使用XML文档注视进行描述。
    XML文档注释主要目的是为了生成文档
      

  2.   

    假如是这样的呢?
    /// <summary>
    /// pInfoInで与えられた情報より元にコード語を生成する関数
    /// </summary>
    /// …………
    public int PDF417_MakeCodeWord(ref PDF417_INFO_IN pInfoIn)
    {
        int nCount = 0;
    }
    对于int nCount = 0 是该用///……这种风格注释呢,还是用/// <summary>……</summary>这种风格注释呢?
      

  3.   

    局部变量当然就更不用XML文档注释了。
      

  4.   

    局部变量
    //.....注解就成了CS文件注解一般这样,估计这是从/* ... */ 演化来的, JAVA里这样注解,可生成文档
    /* ABCDEFG
     * copyright(C)2006
     * asdfsd
     * asdfsadasdf
     * asdf 
     */ 
      

  5.   

    /// <summary>
    /// pInfoInで与えられた情報より元にコード語を生成する関数
    /// </summary>
    /// …………
    ///<param name="PDF417_INFO_IN pInfoIn">
    ///your Explain
    ///</param>
    internal int PDF417_MakeCodeWord(ref PDF417_INFO_IN pInfoIn)
    {
        int nCount = 0;
    }
      

  6.   

    现在只支持<param> <cref> <summary>
    三个吧