批处理之家 - Powered by Discuz! Board

标题: [讨论]论坛是否应该提倡给代码加注释 [打印本页]

作者: namejm 时间: 2009-5-17 20:54 标题: [讨论]论坛是否应该提倡给代码加注释

　　有会员反映说，如果给代码加上注释，将会给新手学习带来很大方便，也方便别人检查。请大家讨论一下，论坛是否应该提倡给代码添加注释？如果要添加，将用何种格式添加？请大家给出赞成或反对的理由，论坛将在大家合理建议的基础上，做出相应的调整。

==============传说中的分割线，强力分隔上下文=====================

　　发现大家的讨论对这个提倡有点误解，以为是对每个代码都强制要求写注释，实际上，对每个代码都添加注释是没必要的，也是不可能的，我们只是提倡对代码添加注释，以方便新手的学习而已，而非强制要求。如果论坛能坚持这样做，将会极大方便新手的学习，并且能形成论坛的特色——不必人人都如此，只需要有几个人能长期坚持下来就已经足够了。

作者: h168855858 时间: 2009-5-17 21:06

O(∩_∩)O哈哈~、、
我提出来滴。嗯。低调低调、、、

各位，虽然我玩电脑有8年了吧，从5年纪开始到现在大二。
咕~~(╯﹏╰)b、、、竟然算错了，是2+6+2=10.哇。。。不知不觉竟然10年了，我才20岁...

喜欢琢磨一些小技巧，学习的东西都比较杂。
批处理以前也玩过，都是下载别人弄好的。
这次学习是因为今天刚弄了一个文件夹图标病毒免疫BAT。兴奋ing、、、

趁着热情还在，就上了这个BBS。发现好多bbs的代码都没有怎么加注释，和C++，VB那些区别很大，那些很多都是加了注释的。

所以我跟管理员提了一下。。。

我只是个“脚本小子”...估计只有老网友才记得还有这个称号吧，哈哈。。

作者: dali 时间: 2009-5-17 21:07

每句都加工作量太大太简单的加了反而使新手养成惰性  不去看教程
我想看完教程的话一般代码都应该能看懂了
有些有点难度的代码最好是加注释和例子
                        个人意见

作者: h168855858 时间: 2009-5-17 21:12 标题: 回复 3楼的帖子

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

作者: dali 时间: 2009-5-17 21:14

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

作者: namejm 时间: 2009-5-17 21:24

Re dali 第5楼：

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

To all：

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

作者: byl2005 时间: 2009-5-17 21:26

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

作者: h168855858 时间: 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、在关键之处写上注释
*----
赞同，可以不在每句后都加注释。如果有个大概意思，知道这一块是干嘛的也好。因为好多都是直接说这段代码是干嘛干嘛的，没有大概说一下代码的流程或意思

作者: 0428_hai 时间: 2009-5-17 22:19

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

作者: zjw767676 时间: 2009-5-17 22:28

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

作者: xxx 时间: 2009-5-19 19:22

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

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

作者: namejm 时间: 2009-5-19 19:48

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

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

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

作者: wxcute 时间: 2009-5-19 19:55

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

作者: namejm 时间: 2009-5-19 22:41

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

作者: batchcaicai 时间: 2009-7-10 11:02

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

作者: temp 时间: 2009-8-12 12:50

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

作者: canyuexiaolang 时间: 2009-8-28 19:03

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

欢迎光临批处理之家 (http://bbs.bathome.net/)