论坛首页 综合技术论坛

你写注释吗?

浏览 14012 次
精华帖 (0) :: 良好帖 (2) :: 新手帖 (1) :: 隐藏帖 (24)
作者 正文
   发表时间:2008-06-04  
据统计,每个程序开发人员的工作时间中,只有不到一半的时间是花在写代码上,其它的时间一部分是在阅读别人或者自己以前写的代码,另一部分则是花在代码的导航定位上。
就拿使用eclipse的开发人员来说,你可能只有一部分的时间是集中在编辑器中写代码,而很多时间你会花在其它的像Package Explorer,Open Type,等视图上。
Eclipse的Open Type和Search等功能可以方便我们很快的查找和定位到相应的代码,但这些都是基于代码的查找和定位,开发人员有时更需要根据自己对代码的标记来查找和定位。
Eclise的tasks和bookmarks的视图提供了对代码标记的功能.
Eclipse的task机制提供了以注释的形式在代码里面描述任务的功能,在用ECLISPE开发JAVA的时候,你可以在注释中插入一些预先定义好的任务的标记,像“TODO”,“FIXME”,“XXX”,“HACK”等。利用这些,你可以实现比常规注释更丰富的功能.
通过做下面这个测试,你可以看下你平常注释的特点和你没考虑到的注释的功能.
http://www.surveymonkey.com/s.aspx?sm=aw7dCPMNTKT_2b8qR0sE8YnA_3d_3d
   发表时间:2008-06-20  
提交问卷了。

你们的页面中的 checkbox 的样式做的挺好看的。呵呵。

点起来很有感觉~~~
0 请登录后投票
   发表时间:2008-06-24  
代码写得干净点,要那么多注释干嘛
0 请登录后投票
   发表时间:2008-11-17  
TODO算是一个很有用的功能,一般我会把我待做的事情放在一个单独的文件里。像是一个todo list一样。
0 请登录后投票
   发表时间:2009-03-26  
andylj511 写道
注释有时候比代码更重要。。别人拿了你的代码没注释。看起来很头痛~

1+1什么时候=3, 在算错的情况下等于3.
1 请登录后投票
   发表时间:2009-05-04  
请以上人员翻阅以前关于文档和注释的讨论。
如果你们都不能推翻以前讨论的理由,我也就认为你们写的注释不会起到你们声称的作用。
你们这种想当然的态度,其实就是注释起不到任何正面影响作用的根本原因。只要你们这种做法不改变,注释即便有很好的作用,也不可能发挥出来。而如果跟你们这样的人一起合作,那么我就会坚持不写任何的注释。
0 请登录后投票
   发表时间:2009-05-05  
注释和文档是两个概念。
0 请登录后投票
   发表时间:2009-05-05  
cyberblue 写道
注释和文档是两个概念。

但是某些属性是共通的
0 请登录后投票
   发表时间:2009-05-05  
最好的注释是代码,印象中是uncle Bob说的。
但是好像kent beck说最好的文档是代码。
所以,嘿嘿。
写代码这事情不能细说啊~
0 请登录后投票
   发表时间:2009-05-06  
黑暗浪子 写道
最好的注释是代码,印象中是uncle Bob说的。
但是好像kent beck说最好的文档是代码。
所以,嘿嘿。
写代码这事情不能细说啊~

文字的东西很不可靠,因为无法测试,无法验证。是否同步就显得很不好验证。
比如你写了个注释,别人在这之后修改了代码,但是注释忘记了。测试也通过了,运行和部署都没有问题。但是过了之后,忽然出现了bug,你跟着注释一看,这块不应该有问题,放过的机会非常大。
而且我这个人私下认为,一个人写不好代码,希望他们写的注释和文档要能好,也是有点奢望。反正我见到的主要是能写好代码的,也能写好注释和文档,只不过他们不愿意写。
另外一个更加麻烦的事情是,以后SCM工具和CASE之类的东西,往往喜欢在注释里面添加点什么,而有的部署工具也喜欢在代码里面填东西。遇到这种情况十分难以控制最终究竟会发生什么问题。
同时你还会发现,自然文字的东西往往有多义性,特别是别人看的时候,产生错误理解的可能性很大。如果那个人刚好是一个跟上面这些不喜欢动脑筋,也不喜欢查资料的人所类似,那么后果就十分的不能被控制。
所以我十分反感在完成的代码中出现人手工写的和维护的注释。今天我再次重复一遍,但愿这个是最后一次了。
1 请登录后投票
论坛首页 综合技术版

跳转论坛:
Global site tag (gtag.js) - Google Analytics