[讨论]论坛是否应该提倡给代码加注释

Rank: 8 Rank: 8

帖子: 647
积分: 3454
技术: 24
捐助: 0
注册时间: 2009-4-25

17楼

发表于 2009-8-28 19:03 | 只看该作者

代码注释只是对于像我这种新人而言，而加上注释又太麻烦，所以在那种精华帖加比较好

temp

六级士官

Rank: 4

帖子: 160
积分: 452
技术: 1
捐助: 0
注册时间: 2009-8-12

16楼

发表于 2009-8-12 12:50 | 只看该作者

加注释有利也有弊,利是一目了然,弊是批处理文件太大
不如专门附带一个帮助文件

batchcaicai

Rank: 2

帖子: 1
积分: 102
技术: 0
捐助: 0
注册时间: 2009-6-27

15楼

发表于 2009-7-10 11:02 | 只看该作者

可以在for循环语句和一些注册表调用语句上，rem

namejm

Rank: 8 Rank: 8

帖子: 1348
积分: 5192
技术: 145
捐助: 501
注册时间: 2007-10-25

14楼

发表于 2009-5-19 22:41 | 只看该作者

　　注释比代码多就没必要了，注释和代码一样应该提倡简洁、清晰。

尺有所短寸有所长，学好批处理没商量；
考虑问题复杂化，解决问题简洁化。
心在天山，身老沧州。

wxcute

Rank: 8 Rank: 8

帖子: 618
积分: 6100
技术: 9
捐助: 0
注册时间: 2008-8-10

13楼

发表于 2009-5-19 19:55 | 只看该作者

个人不提倡细注（详细的注释），简洁的功能块注释就够了。

批处理之家论坛官方 QQ 群：【当前人数/人数上限】【2009-07-08】
群①：43011867（181/200）；群②：（暂缺数据）；群③：66165582（120/200）。

namejm

Rank: 8 Rank: 8

帖子: 1348
积分: 5192
技术: 145
捐助: 501
注册时间: 2007-10-25

12楼

发表于 2009-5-19 19:48 | 只看该作者

　　xxx引用的话说得好：代码不是只给机器执行的时候才用的，更重要的，是要给人看的，不仅仅是别人，还有可能是给自己看。

　　有可能是日后要持续维护代码，也可能是想从以前写的代码中抽出一些片段拿来复用……1天之后，你可能还记得自己当初每条代码的含义；一个月之后，你可能只能理解到90%；半年之后，你可能还记得住50%；1年之后，你很可能连自己当初的思路都已经彻底忘掉了。该怎么办？

　　答案是：养成随手写注释的习惯！

尺有所短寸有所长，学好批处理没商量；
考虑问题复杂化，解决问题简洁化。
心在天山，身老沧州。

xxx

三级士官

Rank: 3 Rank: 3

帖子: 53
积分: 225
技术: 0
捐助: 0
注册时间: 2009-3-19

11楼

发表于 2009-5-19 19:22 | 只看该作者

UNIX哲学二：清晰胜于技巧
维护如此重要而成本如此高昂；在写程序时，要想到你不是写给执行代码的计算机看的，而是给人——将来阅读维护源码的人，包括你自己——看的。
在UNIX传统中，这个建议不仅意味着代码注释。良好的UNIX实践同样信奉在选择算法和实现时就应该考虑到将来的可扩展性。而为了取得程序一丁点的性能提升就大幅度增加技术的复杂性和晦涩性，这个买卖做不得——这不仅仅是因为复杂的代码容易滋生Bug，也因为它会使日后的阅读和维护工作更加艰难。
相反，优雅而清晰的代码不仅不容易崩溃——而且更易于后来的修改者立即理解。这点非常重要，尤其是说不定若干年后回过头来修改这些代码的人可能恰恰是你自己。

永远不要去吃力地解读一段晦涩的代码三次。第一次也许侥幸成功，但如果发现必须重新解读一遍——离第一次太久了，具体细节无从回想——那么你该注释代码了，这样第三次就相对不会那么痛苦了。
——Henry Spencer

1 评分人数

Batcher: 感谢分享PB + 5

zjw767676

上校

Rank: 6 Rank: 6

帖子: 276
积分: 3596
技术: 0
捐助: 0
注册时间: 2008-12-21

10楼

发表于 2009-5-17 22:28 | 只看该作者

可能最好的办法就是：
1、先整体介绍一下代码的思路
2、在关键之处写上注释

1 评分人数

batman: 说得好！PB + 2

有一种爱叫放弃

0428_hai

六级士官

Rank: 4

帖子: 98
积分: 384
技术: 1
捐助: 0
注册时间: 2009-5-9

9楼

发表于 2009-5-17 22:19 | 只看该作者

可以在关键性的一句或几句上点一下，有时候可能就是一句话甚至是一个词就能带来恍然大悟的效果。

h168855858

Rank: 2

帖子: 19
积分: 148
技术: 0
捐助: 0
注册时间: 2009-5-17

8楼

发表于 2009-5-17 22:04 | 只看该作者

bat-Saber(814751832)21:12:23
如果代码简单就不用注释了.
bat-16885585821:12:48
额。。。
bat-16885585821:13:40
任何东西都是当你学会了，你都会觉得“也不过如此嘛”...问题是：“没学会之前呢？”那可是个槛啊！~
bat-namejm(13132002)21:15:40
对所有代码都加上注释是不现实的
只能选择一些难以理解的地方加注释就可以了
bat-16885585821:17:29
那你们可以说说，简单的代码，是属于哪一种么？或者哪一类么？
bat-Saber(814751832)21:17:37
如果简单的代码都要注释，那将会对新手造成懒隋的心理
代码要亲自动手弄过思考过才会了解深入，
看注释看明白了，但会很易忘记的。
所以只有对难以理解的注释一下就可以了，比如算法等
bat-dali(279325850)21:18:38
基础教程里的都是简单的代码意思就是看完基础教程  你还看不懂的代码  就应该加注释了
bat-Saber(814751832)21:19:04
在命令提示符用help 有帮助信息的都较简单
bat-namejm(13132002)21:19:06
可能最好的办法就是：
1、先整体介绍一下代码的思路
2、在关键之处写上注释
bat-Saber(814751832)21:21:28
嗯  一个代码思路是很重要的
bat-16885585821:22:22
bat-namejm(13132002)  21:19:06
可能最好的办法就是：
1、先整体介绍一下代码的思路
2、在关键之处写上注释
*----
赞同，可以不在每句后都加注释。如果有个大概意思，知道这一块是干嘛的也好。因为好多都是直接说这段代码是干嘛干嘛的，没有大概说一下代码的流程或意思

byl2005

Rank: 2

帖子: 3
积分: 110
技术: 0
捐助: 0
注册时间: 2009-4-1

7楼

发表于 2009-5-17 21:26 | 只看该作者

个人认为最好是看教程大致会的就不用加了其他的加上倒也可以提高一下初学者的水平

namejm

Rank: 8 Rank: 8

帖子: 1348
积分: 5192
技术: 145
捐助: 501
注册时间: 2007-10-25

6楼

发表于 2009-5-17 21:24 | 只看该作者

Re dali 第5楼：

　　你这个建议也不错，论坛将会考虑推广这种做法，但是不一定非得由管理人员在QQ群里发，因为管理人员不一定全天都在线，会员也可以发。

To all：

　　如果有和本主题不同的其他提议，建议在相应版块另开新帖讨论，以便做到专帖专用，希望后面的帖子能专注于顶楼的讨论。

尺有所短寸有所长，学好批处理没商量；
考虑问题复杂化，解决问题简洁化。
心在天山，身老沧州。

dali

Rank: 2

帖子: 14
积分: 144
技术: 0
捐助: 0
注册时间: 2009-5-8

5楼

发表于 2009-5-17 21:14 | 只看该作者

另外希望有好贴热帖
版主看到后能在Q群里给个链接
因为我想很多人都不可能长时间逛论坛
Q群里也大家也不大活跃
版主在Q群发链接的话既能给帖子增加人气也能让大家增长知识
总之好处多多
            个人意见

1 评分人数

namejm: 建议非常好，值得提倡。PB + 2

h168855858

Rank: 2

帖子: 19
积分: 148
技术: 0
捐助: 0
注册时间: 2009-5-17

4楼

发表于 2009-5-17 21:12 | 只看该作者

回复 3楼的帖子

也不是从头到尾都加呀。。。如果一段代码里，有重复的，后面的可以不用加了嘛。。。