用户工具

站点工具

导航栏

基本语法


交流留言

wiki:tools:c井注释编码规范



C#注释编码规范

修改日志

文件的创建

//################################################
// Create by wuyingqiang.cn on 2016-05-04
//################################################
  • 追加在文件最上方;
  • 48个“#”号开始和结束;
  • 固定以谓词“Create”开头,注意开头字母大写;
  • 左侧保留一个半角空格;
  • 姓名:中文真实姓名的拼音表示,开头字母大写。例:wuyingqiang.cn,shams.cn;
  • 日期:表示格式YYYY-MM-DD,例:2016-05-04;

代码块的修改

//++++++++++++++++++++++++++++++++++++++++++++++++
// 修正概要:增加子部门图标,mantis #0001834
// 修正日志:Add/Update/Delete by wuyingqiang.cn on 2016-05-04
public string Organization { get; set; }
public string User { get; set; }
……
//++++++++++++++++++++++++++++++++++++++++++++++++
  • 48个“+”号开始和结束;
  • 修正概要和修正日志的左侧,保留一个半角空格;
  • 修正概要和修正日志的右侧,一个全角“:”号;
  • 修正日志:,以谓词“Add / Update / Delete”开头,注意开头字母大写;
  • 姓名:中文真实姓名的拼音表示,开头字母大写。例:wuyingqiang.cn,shams.cn;
  • 日期:表示格式YYYY-MM-DD,例:2016-05-04;

追加例

//++++++++++++++++++++++++++++++++++++++++++++++++
// 修正概要:追加组织机构、用户属性,mantis #0001834
// 修正日志:Add by wuyingqiang.cn on 2016-05-04
public string Organization { get; set; }
public string User { get; set; }
……
//++++++++++++++++++++++++++++++++++++++++++++++++

修改例

//++++++++++++++++++++++++++++++++++++++++++++++++
// 修正概要:修改……,mantis #0001834
// 修正日志:Update by wuyingqiang.cn on 2016-05-04
//public string Organization { get; set; }
//public string User { get; set; }
public string Organization2 { get; set; }
public string User2 { get; set; }
//++++++++++++++++++++++++++++++++++++++++++++++++

删除例

//++++++++++++++++++++++++++++++++++++++++++++++++
// 修正概要:……,mantis #0001834
// 修正日志:Delete by wuyingqiang.cn on 2016-05-04
//public string Organization { get; set; }
//public string User { get; set; }
//++++++++++++++++++++++++++++++++++++++++++++++++

方法(函数)的注释

方法(函数)头

/// <summary>
/// 删除最后字符
/// </summary>
/// <param name="str">源字符串</param>
/// <param name="Length">删除长度</param>
/// <returns>返回删除后的字符串</returns>
public static string DeleteLastLength(string str, int Length)
{
    if (string.IsNullOrEmpty(str))
        return "";
    str = str.Substring(0, str.Length - Length);//
    return str;
}
  • 强调summary、param、returns的说明……

首篇前一篇后一篇末篇

wiki/tools/c井注释编码规范.txt · 最后更改: 2020/05/16 19:51 (外部编辑)

oeffentlich