C#编码规范之代码的增删改约定

  • 增加 ,仅增加一行时可以是这样“int a = GetScale(obj, col); // 描述。add by Tome 2018-9-20”,多行时见下。
#region add by Tome 2018-9-20
//原因:描述
int a = GetScale(obj, col);
#endregion
  • 删除 ,仅删除一行时可以是这样//int a = GetScale(obj, col); // 描述。delete by Tome 2018-9-20,多行时见下。删除的代码确实没存在的意义,可以考虑1年后直接从文件中移除掉。
#region delete by Tome 2018-9-20
//原因:描述
/*int a = GetScale(obj, col);*/
#endregion
  • 修改 ,下面演示了支持多次修改的情况。约定:最近一次修改的region在最外层,并且每个region分上中下三部分,‘上’是修改原因,‘中’是注释掉的旧代码,‘下’是新代码。
#region update by Tome 2018-10-20

//原因:描述2
#region update by Tome 2018-9-20 
//原因:描述
/*int a = GetScale(obj,type, col);*/
/*int a = GetScale(obj, col);*/
#endregion
int a = GetScale(obj, groupId, col);

#endregion

  • 另外某段代码业务规则超级复杂,增加或修改代码时有必要在备注里写明你的编码依据,如客户提供的算法规则等。

posted on 2019-01-18 10:49  anjun_xf  阅读(156)  评论(0编辑  收藏  举报

导航

TOP