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>

为函数方法注释说明要用到 xml 语句  段落说明  、 新段示例说明 、   空行要加入全角空格

下面的注释会破坏原有标注结构:

        /// <summary> 第一行 说明
        /// <para>第二行说明</para>
        /// <para> ←最前面的空格要加入全角空格才会显示</para><para> </para><para> 上面一行是空行</para>
        /// <param name="s"> s 为表名,不要加 .xml 后缀</param>
        /// <para> 异常:...</para>
        /// <returns> 返回:成功 - true;失败 - false。</returns>
        ///</summary>
        private void getXmlTable(string s, DataGridView dataGView, ComboBox com, Button ton){
   }

原语句:


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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值