论坛首页 入门技术论坛

编程中的一点感受

浏览 1321 次
精华帖 (0) :: 良好帖 (1) :: 新手帖 (0) :: 隐藏帖 (2)
作者 正文
   发表时间:2008-11-05  
    最近挺忙的,一直在写一些新程序的spec,也在修改live上的程序的Bug,第一次感觉到注释的作用。所以想简单说说,以前只是听说写代码要写注释,也就照着去做,没有什么特别的感觉,这段时改了不少前辈的代码,发现注释的重要性,感觉到一些做注释的要求,每行代码,每个声明的变量都要做注释,在需要的地方注释。可读性强的代码需要很少的注释。如果所有的变量和方法的命名都很有意义,会使代码可读性很强并无需太多注释。行数不多的注释会使代码看起来优雅。但如果代码不清晰,可读性差,那就糟糕。如果应为某种原因使用了复杂艰涩的原理,为程序配备良好的文档和重分的注释。对一个数值变量采用不是0,-1等的数值初始化,给出选择该值的理由。简言之,要写清晰,可读的代码以致无须什么注释就能理解。对注释做拼写检查,保证语法和标点符号的正确使用。说句实话好多时间都浪费在了那些注释不明的程序上了,就看越乱特别是比较长的代码,就更晕了,这里就是小提示一下,大家做注释啊!就不白写这段文字!哈哈
论坛首页 入门技术版

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