C# 三綱註釋的設置問題

    C#中新建的類庫添加註釋時,應注意以下問題:

   1、編譯動態類庫時命名空間要規範,一般不要和類同名,命名空間一般定義格式:項目名+類文件名;

   2、動態類庫中,類、方法的註釋都採用下列方式註釋:

    類註釋的格式:

    /// <summary>
    /// 文件名:Ini處理類/
    /// 文件功能描述:讀寫Ini文件/
    /// 版權所有:Copyright (C) ZGM/
    /// 創建標識:2011.12.13/     /// 修改描述:/
    /// </summary>

    方法註釋的格式:

    /// <summary> 
    /// 讀出Ini文件
    /// </summary>
    /// <param name="Section">Ini文件中的段落名稱</param>
    /// <param name="Key">Ini文件中的關鍵字</param>
    /// <param name="IniFilePath">Ini文件的完整路徑和名稱</param>
    /// <returns>Ini文件中關鍵字的數值</returns>



 3 、生成與動態類庫相同名稱的xml文件,具體設置是:項目右鍵—>屬性—>生成—>XML文檔文件選中再編譯



4、引用動態類庫時,把類庫和同名的xml文件放到同一個文件夾內即可。


5、效果如下:


原文地址:http://hi.baidu.com/jiang_yy_jiang/blog/item/78da74092a314d3a6a60fb53.html

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章