全球主机交流论坛

 找回密码
 注册

QQ登录

只需一步,快速开始

CeraNetworks网络延迟测速工具IP归属甄别会员请立即修改密码
查看: 710|回复: 24
打印 上一主题 下一主题

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

[复制链接]
跳转到指定楼层
1#
发表于 2020-7-2 10:33:40 | 只看该作者 回帖奖励 |正序浏览 |阅读模式
// 说明 if else 的注释
if (....) {
// 说明以下 判断块 的注释
// 说明第一句代码的注释(这里该怎么让块和第一句的注释有所区别,这样不是在一起了)
....巴拉巴拉
....巴拉巴拉
....巴拉巴拉
....巴拉巴拉
} else {
// 说明以下 内容块 的注释
....巴拉巴拉
....巴拉巴拉
....巴拉巴拉
....巴拉巴拉
}
推荐
发表于 2020-7-2 11:18:44 | 只看该作者
最烦两件事:1.别人的代码不写注释;2.写注释。
推荐
发表于 2020-7-2 10:47:55 | 只看该作者
正经人谁写注释?????
尽量让一个方法只做一件事,尽量把方法名写清楚,方法名尽量不要简写,不要怕他名字长;
能用变量名,能用方法名说明代码功能的尽量不要写注释;
注释一般用于实在代码表达不清楚的地方。
注释太多等于无。
推荐
发表于 2020-7-2 10:36:09 | 只看该作者
写这么多注释还不如把变量名起得有意义一点
25#
发表于 2020-7-2 16:42:13 | 只看该作者
别用拼音的首字母组成变量名就好,这玩意一般人还真看不懂,哪怕全拼都行
24#
发表于 2020-7-2 16:33:28 | 只看该作者
注释写的比代码多
之前写过一个python程序  程序段82行 注释97行
这种把注释写成半个开发文档的情况利于后续开发以及他人接手
23#
 楼主| 发表于 2020-7-2 16:25:59 | 只看该作者
野兔 发表于 2020-7-2 11:18
最烦两件事:1.别人的代码不写注释;2.写注释。

比起写文档说明还是好多了。。。
21#
发表于 2020-7-2 11:12:14 | 只看该作者
变量名别太**就行了...
20#
发表于 2020-7-2 11:00:30 | 只看该作者
去看阿里的代码规范
19#
 楼主| 发表于 2020-7-2 10:58:47 | 只看该作者
极限挑战 发表于 2020-7-2 10:52
擦  光顾着看你头像去了

色即是空,空即使色
18#
发表于 2020-7-2 10:56:44 | 只看该作者
senwzz 发表于 2020-7-2 10:53
如果写尾部只能写一行,多行就不行了

大致描述一下就好了,详细看代码啊, 自己写的还看不懂嘛。   
工作都在注释上了不然
17#
 楼主| 发表于 2020-7-2 10:55:15 | 只看该作者
heihai 发表于 2020-7-2 10:41
虽然说清晰的注释很重要,但也没必要像这样搞吧

要写啊,一年后自己都看不懂自己当初是怎么个想法,注释为了自己快速回忆进入状态,防止越改越错
您需要登录后才可以回帖 登录 | 注册

本版积分规则

Archiver|手机版|小黑屋|全球主机交流论坛

GMT+8, 2026-1-15 06:41 , Processed in 0.074862 second(s), 11 queries , Gzip On, MemCache On.

Powered by Discuz! X3.4

© 2001-2023 Discuz! Team.

快速回复 返回顶部 返回列表