C# <summary> 三纲注释的设置问题

    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

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值