1.大型公司的代码注释是怎样的
写代码之前写一部分,调试时候写一部分,写完代码之后补一部分
写代码之前的:等于是你的提纲,也是后来人理解你代码的途径
//这里取出两个用户Tom,Jerry
//如果Tom年龄大,则返回true
//遍历列表,查找两个人的同类
//如果Tom的同类多返回true
//如果Tom个子高返回true
调试时候的:
//print tom.age //不应该大于lily.age
调试时候你打印的变量,可能是后来人改代码时的关键检查点,可以考虑一部分变成注释
写完功能后:对于不好理解的地方再补点注释,原则是后人改代码时候一眼就看清你的思路
重构/复查代码时候:如果你俩礼拜之后对着一个你写的/别人写的地方琢磨了半天不知道啥意思,要么你改算法,要么至少留点注释
对于英文不好的同学,就不要在注释里强秀英文了……过俩月自己都看不懂了
变量/类名字如果是你用有道词典或者百度查出来的单词……麻烦在声明的地方加个中文注释
本文采摘于网络,不代表本站立场,转载联系作者并注明出处:https://www.qiming5.com/gsqm/8167.html
