比起这个还有更变态的,不过不是编码规则,是代码修改注释。
某公司是这么规定的,当产品到达一定的miletone以后,所有代码修改都需要有一个标
准注释。
首先,当然是要产生一个issue或者ticket描述为啥修改,然后:
如果你是单纯的新增代码,那么:
// begin ISSUE-XXX ADD BY XXXXX(姓名拼音) YYYYYYYY(工号), 20XX/XX/XX
your code
// end ISSUE-XXX ADD BY XXXXX(姓名拼音) YYYYYYYY(工号), 20XX/XX/XX
修改代码就是把以上ADD替换成MODIFIED。然后就可以经常看到如下代码:
// begin ISSUE-966 MODIFIED BY GEBILAOWANG 99999, 2011/11/11
// begin ISSUE-485 MODIFIED BY ZHAOSI 99998, 2010/11/11
// begin ISSUE-333 MODIFIED BY ZHANSAN 99990, 2010/05/11
// begin ISSUE-234 ADD BY LAOYUANGONG 99980, 2010/01/11
SOME CODE
// end ISSUE-234 ADD BY LAOYUANGONG 99980, 2010/01/11
SOME CODE
// end ISSUE-333 MODIFIED BY ZHANSAN 99990, 2010/05/11
SOME CODE
// end ISSUE-485 MODIFIED BY ZHAOSI 99998, 2010/11/11
// end ISSUE-966 MODIFIED BY GEBILAOWANG 99999, 2011/11/11
这么代码读起来简直是棒棒哒!