写注释写的时候觉得写得特别清楚,过段时间回来再看,都不知在说啥了,是我英语不好。 - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
请不要在回答技术问题时复制粘贴 AI 生成的内容
33 条回复    2018-12-24 15:10:37 +08:00
GDC
    1
GDC  
   2018-12-22 14:27:43 +08:00 via iPhone   1
写中文 或者双语
likuku
    2
likuku  
   2018-12-22 14:35:02 +08:00   1
试试念个写作班?写的时候把“读者”定位成纯小白,或许会好点。
DonaldY
    3
DonaldY  
   2018-12-22 15:01:31 +08:00   1
题主想说:

1. 英语不好 - 》注释写不好?

2. 英语不好 - 》代码写不好?
yidinghe
    4
yidinghe  
   2018-12-22 15:02:08 +08:00   2
楼主写中文注释是否有困难
SeaRecluse
    5
SeaRecluse  
   2018-12-22 15:44:02 +08:00   1
为什么要写注释,合理的命名+逻辑+文档才对,个人调试用的也没必要上非母语啊?
AvenirX
    6
AvenirX  
   2018-12-22 16:06:34 +08:00 via iPhon   1
你可以写完了放到谷歌翻译翻成中文,然后修改到你能看懂中文为止。下次看不懂自己注释了你就谷歌翻译一下
kindjeff
    7
kindjeff  
   2018-12-22 16:50:38 +08:00   1
稍微长一点的注释我都用专门切一下输入法用中文,不是看不看得懂的问题是我不会写。
huangzhe8263
    8
huangzhe8263  
   2018-12-22 16:52:39 +08:00 via Android   2
当我写注释的时候,我和上帝知道我在写什么。
过段时间当我回头看的时候,只有上帝知道了。
lueffy
    9
lueffy  
   2018-12-22 17:00:25 +08:00 via iPhone   1
只是写代码不是看英文书籍的话
我觉得对英语水平高中水平就绝对够了啊或者有检索的能力就行
一般也就方法 /变量 /类的命名,使用欧路 /有道 /谷歌等翻译一下就行啊
保证中文翻成的英文,再翻回中文时,意思是一致的就行
就算你下次再见到不认识,再用软件翻译下就行了
总之千万不要用拼音缩写,别人真的很难读懂
atonku
    10
atonku  
   2018-12-22 17:25:57 +08:00
你肯定是翻译的英文,哈哈哈哈
asLw0P981N0M0TCC
    11
asLw0P981N0M0TCC  
   2018-12-22 17:29:18 +08:00
写注释要英文吗。。为什么不直接用中文啊 我都中文的。。虽然不太美观
msg7086
    12
msg7086  
   2018-12-22 19:11:10 +08:00   1
首先,你说的 8 级是什么?
CET 大学英语等级考试只有 4 级和 6 级,没有 8 级,你想考也没这个项目给你考。
如果是说专业英语的 TEM4 级和 8 级的话,是给英语专业学生考的。你是英语专业的吗?如果不是,那你报名都不能报。

然后说注释的问题。如果你英语表达不流畅,那么用中文或者双语是很好的选择。注释的目的是要让人看懂,中文当然最方便让人看懂了。如果你们代码贡献者里有非中文使用者,那么写双语也是很好的。
msg7086
    13
msg7086  
   2018-12-22 19:14:07 +08:00   1
另外注释不一定仅限于文字。有些例子你用 ASCII 字符画都可以,比如流程图直接画在注释里,可能可以解释得更清楚。我们有些复杂的 Story 我都是先写一份 LaTeX PDF 的详细文档,把前前后后全部说明清楚,把 PDF 附在 Story Ticket 里,再在代码里引用这个 Ticket ID。这样任何时候我要回顾历史,都可以找到详细的说明材料。
JasonCao2018
    14
JasonCao2018  
   2018-12-22 21:21:51 +08:00
首先、请老老实实用中文
OMan
    15
OMan  
   2018-12-22 21:24:39 +08:00   1
我这过了 6 级的,还不是老老实实写中文注释,
akira
    16
akira  
   2018-12-22 22:33:22 +08:00   1
自己写的注释 ,自己都看不懂的话,那是表达能力有问题,就算你写的是中文,一样有可能看不懂
jingyulong
    17
jingyulong  
   2018-12-22 22:39:45 +08:00 via iPhone
好的代码是不需要注释的,加油
mason961125
    18
mason961125  
   2018-12-23 00:34:30 +08:00
你自己的代码如果命名规范、逻辑清晰、结构合理,不需要很多注释就能看懂。
flowfire
    19
flowfire  
   2018-12-23 01:32:33 +08:00 via Android
@msg7086 emoji 注释了解一下
xuanwu
    20
xuanwu  
   2018-12-23 05:03:46 +08:00   1
个人项目? 最好直接命名用中文. 一些本站实践者: t/477109. 更多其他实践见"中文编程"知乎专栏.
frittle
    21
frittle  
   2018-12-23 07:27:38 +08:00
自己写得注释自己看不懂应该和使用那种语言无关吧,应该和自身的表达能力或语言组织能力有关。
TonyLiu2ca
    22
TonyLiu2ca  
OP
   2018-12-23 07:42:21 +08:00   1
@GDC @yidinghe @qwertyzzz @JasonCao2018 必须英文
@likuku 我就是老小白
@DonaldY 是真的注释写不好
@SeaRecluse 我的教育阶段都说注释衡量是否是一个合格的程序员的,
@AvenirX 谷歌的翻译很多时候不太好
@kindjeff 勇于承认,这就是勇者
@huangzhe8263 真是这样
@lueffy 真没试过拼音,这个比较的有创意
@atonku 真不是,自己硬写
@msg7086 双语也是好主意
@msg7086 这个比写程序花的时间还长吧。不是学文科的,美术特别不好。
@OMan 就说你,偷懒
@akira 中文的话,98%保证可以看懂
@jingyulong 牛,牛
@mason961125 不看注释,还真是更好看些
@xuanwu 个人的尽量全部中文
ys0290
    23
ys0290  
   2018-12-23 08:14:37 +08:00 via iPhone   1
是不是当时以为懂所以写得很简洁,之后忘了不懂了就感觉是天书了
hjw45611
    24
hjw45611  
   2018-12-23 09:11:48 +08:00 via iPhone   1
多看看 重构:改善既有代码的设计 这本书
lxerxa
    25
lxerxa  
   2018-12-23 09:44:04 +08:00 via iPhone
@jingyulong 赞同,好的代码本身就是注释了
OldPanda
    2
OldPanda  
   2018-12-23 11:43:13 +08:00
这很正常,这个时候就该考虑重构了
niubee1
    27
niubee1  
   2018-12-23 11:53:53 +08:00   1
好的注释应该包含下面几个部分
1. 标题: 这段代码的助记名称
2. 用途: 这段代码的用途
3. 逻辑: 说明代码运行的逻辑, 可能的话包含逻辑图之类的, 用转 ascii 图工具转义好贴进去
4. 参数说明表: 每个参数的名称, 类型, 限制
5. 返回值说明: 类型,
6. 异常表, 如果语言不支持异常而是通过返回错误, 那么在上面一项说明
4. 调用示例: 如何调用这段代码的例子

不过这么干的话, 注释比代码正文都长, 我估计国内是没有公司会吃饱了撑的这么写
wolfie
    28
wolfie  
   2018-12-23 14:30:03 +08:00
注释跟英语有什么关系。
SuperMild
    29
SuperMild  
   2018-12-23 15:52:23 +08:00   2
@xuanwu 说到中文编程,很多人会说来回切换输入法麻烦,但明明注释和一些字符串也很多人用中文,怎么就不嫌麻烦了。
2kCS5c0b0ITXE5k2
    30
2kCS5c0b0ITXE5k2  
   2018-12-23 16:37:43 +08:00
为什么一定要写英语呢...
lepig
    31
lepig  
   2018-12-24 00:20:21 +08:00
团队最好用中文 还要考虑下别的队友。
jorneyr
    32
jorneyr  
   2018-12-24 09:02:36 +08:00
写好后让其他队友再看一遍, 能否容易理解
Evilk
    33
Evilk  
   2018-12-24 15:10:37 +08:00
我写释,一般都是中文
关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     891 人在线   最高记录 6679       Select Language
创意工作者们的社区
World is powered by solitude
VERSION: 3.9.8.5 25ms UTC 19:17 PVG 03:17 LAX 11:17 JFK 14:17
Do have faith in what you're doing.
ubao msn snddm index pchome yahoo rakuten mypaper meadowduck bidyahoo youbao zxmzxm asda bnvcg cvbfg dfscv mmhjk xxddc yybgb zznbn ccubao uaitu acv GXCV ET GDG YH FG BCVB FJFH CBRE CBC GDG ET54 WRWR RWER WREW WRWER RWER SDG EW SF DSFSF fbbs ubao fhd dfg ewr dg df ewwr ewwr et ruyut utut dfg fgd gdfgt etg dfgt dfgd ert4 gd fgg wr 235 wer3 we vsdf sdf gdf ert xcv sdf rwer hfd dfg cvb rwf afb dfh jgh bmn lgh rty gfds cxv xcv xcs vdas fdf fgd cv sdf tert sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf shasha9178 shasha9178 shasha9178 shasha9178 shasha9178 liflif2 liflif2 liflif2 liflif2 liflif2 liblib3 liblib3 liblib3 liblib3 liblib3 zhazha444 zhazha444 zhazha444 zhazha444 zhazha444 dende5 dende denden denden2 denden21 fenfen9 fenf619 fen619 fenfe9 fe619 sdf sdf sdf sdf sdf zhazh90 zhazh0 zhaa50 zha90 zh590 zho zhoz zhozh zhozho zhozho2 lislis lls95 lili95 lils5 liss9 sdf0ty987 sdft876 sdft9876 sdf09876 sd0t9876 sdf0ty98 sdf0976 sdf0ty986 sdf0ty96 sdf0t76 sdf0876 df0ty98 sf0t876 sd0ty76 sdy76 sdf76 sdf0t76 sdf0ty9 sdf0ty98 sdf0ty987 sdf0ty98 sdf6676 sdf876 sd876 sd876 sdf6 sdf6 sdf9876 sdf0t sdf06 sdf0ty9776 sdf0ty9776 sdf0ty76 sdf8876 sdf0t sd6 sdf06 s688876 sd688 sdf86