全球编程论坛,代码注释狂魔怎么写比较合适?
侧边栏壁纸
  • 累计撰写 56,889 篇文章
  • 累计收到 0 条评论

全球编程论坛,代码注释狂魔怎么写比较合适?

James
2020-08-29 / 0 评论 / 66 阅读 / 正在检测是否收录...

//说明ifelse的注释

if(....){

//说明以下判断块的注释

//说明第一句代码的注释(这里该怎么让块和第一句的注释有所区别,这样不是在一起了)

....巴拉巴拉

....巴拉巴拉

....巴拉巴拉

....巴拉巴拉

}else{

//说明以下内容块的注释

....巴拉巴拉

....巴拉巴拉

....巴拉巴拉

....巴拉巴拉

}


-----------------------------------------------------
网友回复:

最烦两件事:1.别人的代码不写注释;2.写注释。


网友回复:

正经人谁写注释?????

尽量让一个方法只做一件事,尽量把方法名写清楚,方法名尽量不要简写,不要怕他名字长;

能用变量名,能用方法名说明代码功能的尽量不要写注释;

注释一般用于实在代码表达不清楚的地方。

注释太多等于无。


网友回复:

你这也太多了,一般我就这么干

if(....){ //XX判断开始 条件:xxx
....巴拉巴拉
....巴拉巴拉
....巴拉巴拉
....巴拉巴拉
}else{ //条件外执行XX操作
....巴拉巴拉
....巴拉巴拉
....巴拉巴拉
....巴拉巴拉
} //XX判断结束


网友回复:

介个。。。。

rem

....

语言不一样,注释完全不同


网友回复:

引用:ZjuSa.pRo发表于2020-7-210:40

空一行啊,或者直接注释在第一句后面


网友回复:

正经人谁写注释?????

尽量让一个方法只做一件事,尽量把方法名写清楚,方法名尽量不要简写,不要怕他名字长;

能用变量名,能用方法名说明代码功能的尽量不要写注释;

注释一般用于实在代码表达不清楚的地方。

注释太多等于无。


网友回复:

仅限于工作中哈; //此处说明上诉表达适用范围

如果大佬要写教程出来,每句话都注释也无妨,一般在后面


网友回复:

引用:Jay发表于2020-7-210:45

注释多了,严重影响我一目十行代码


网友回复:

引用:大杀器发表于2020-7-210:43

你这也太多了,一般我就这么干


网友回复:

引用:heihai发表于2020-7-210:41

虽然说清晰的注释很重要,但也没必要像这样搞吧


网友回复:

引用:senwzz发表于2020-7-210:53

如果写尾部只能写一行,多行就不行了


网友回复:

引用:极限挑战发表于2020-7-210:52

擦 光顾着看你头像去了


网友回复:

最烦两件事:1.别人的代码不写注释;2.写注释。


网友回复:

引用:野兔发表于2020-7-211:18

最烦两件事:1.别人的代码不写注释;2.写注释。


网友回复:

注释写的比代码多

之前写过一个python程序 程序段82行注释97行

这种把注释写成半个开发文档的情况利于后续开发以及他人接手


网友回复:

别用拼音的首字母组成变量名就好,这玩意一般人还真看不懂,哪怕全拼都行

0