写注释写的时候觉得写得特别清楚,过段时间回来再看,都不知在说啥了,是我英语不好。

2018-12-22 14:14:24 +08:00
 TonyLiu2ca

这程序员要求英语几级啊,是不是需要 8 级以上啊

5349 次点击
所在节点    程序员
33 条回复
frittle
2018-12-23 07:27:38 +08:00
自己写得注释自己看不懂应该和使用那种语言无关吧,应该和自身的表达能力或语言组织能力有关。
TonyLiu2ca
2018-12-23 07:42:21 +08:00
@GDC @yidinghe @qwertyzzz @JasonCao2018 必须英文
@likuku 我就是老小白
@DonaldY 是真的注释写不好
@SeaRecluse 我的教育阶段都说注释衡量是否是一个合格的程序员的,
@AvenirX 谷歌的翻译很多时候不太好
@kindjeff 勇于承认,这就是勇者
@huangzhe8263 真是这样
@lueffy 真没试过拼音,这个比较的有创意
@atonku 真不是,自己硬写
@msg7086 双语也是好主意
@msg7086 这个比写程序花的时间还长吧。不是学文科的,美术特别不好。
@OMan 就说你,偷懒
@akira 中文的话,98%保证可以看懂
@jingyulong 牛,牛
@mason961125 不看注释,还真是更好看些
@xuanwu 个人的尽量全部中文
ys0290
2018-12-23 08:14:37 +08:00
是不是当时以为懂所以写得很简洁,之后忘了不懂了就感觉是天书了
hjw45611
2018-12-23 09:11:48 +08:00
多看看 重构:改善既有代码的设计 这本书
lxerxa
2018-12-23 09:44:04 +08:00
@jingyulong 赞同,好的代码本身就是注释了
OldPanda
2018-12-23 11:43:13 +08:00
这很正常,这个时候就该考虑重构了
niubee1
2018-12-23 11:53:53 +08:00
好的注释应该包含下面几个部分
1. 标题: 这段代码的助记名称
2. 用途: 这段代码的用途
3. 逻辑: 说明代码运行的逻辑, 可能的话包含逻辑图之类的, 用转 ascii 图工具转义好贴进去
4. 参数说明表: 每个参数的名称, 类型, 限制
5. 返回值说明: 类型,
6. 异常表, 如果语言不支持异常而是通过返回错误, 那么在上面一项说明
4. 调用示例: 如何调用这段代码的例子

不过这么干的话, 注释比代码正文都长, 我估计国内是没有公司会吃饱了撑的这么写
wolfie
2018-12-23 14:30:03 +08:00
注释跟英语有什么关系。
SuperMild
2018-12-23 15:52:23 +08:00
@xuanwu 说到中文编程,很多人会说来回切换输入法麻烦,但明明注释和一些字符串也很多人用中文,怎么就不嫌麻烦了。
2kCS5c0b0ITXE5k2
2018-12-23 16:37:43 +08:00
为什么一定要写英语呢...
lepig
2018-12-24 00:20:21 +08:00
团队最好用中文 还要考虑下别的队友。
jorneyr
2018-12-24 09:02:36 +08:00
写好后让其他队友再看一遍, 能否容易理解
Evilk
2018-12-24 15:10:37 +08:00
我写注释,一般都是中文

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/519992

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX