注册 登录  
 加关注
   显示下一条  |  关闭
温馨提示!由于新浪微博认证机制调整,您的新浪微博帐号绑定已过期,请重新绑定!立即重新绑定新浪微博》  |  关闭

李雪 廊坊师范学院十期信息技术提高班

过错是短暂的遗憾,错过是永远的遗憾!

 
 
 

日志

 
 
 
 

代码格式——注释  

2014-12-31 19:39:16|  分类: 默认分类 |  标签: |举报 |字号 订阅

  下载LOFTER 我的照片书  |
       实习期间,做了一个系统的二期,真心的感觉,养成良好的代码格式,太重要了。首先说,代码是别人的,思想是别人的 ,别人的代码没有注释,思路没有记载,连组基本的各种图也没有,如果是你,怎么下手?所以说,在编写程序时,做好注释,真的太重要了! 下面是给编程朋友的一些建议,欢迎采纳……
1、注释是为了弥补代码表达时的失败;
   尽量用清楚的代码表达意图,而不是使用注释(虽然注释不可避免),因为程序员不能坚持维护注释;
   唯一真正好的注释是你想办法不去写注释;
2、好注释:
   (1)法律信息;
        ----版权信息等;
   (2)提供信息的注释、对意图的解释;
        ----总体注释,函数作用的注释,语句块作用的注释等;
   (3)阐释;
        ----晦涩参数或变量的注释;
   (4)警示;
   (5)TODO注释;
       ----程序员认为应该做,但由于某些原因目前还没有做的工作;
3、坏注释:
   (1)多余的注释、废话注释;
    ----没必要仅仅因为需要而写注释;
    ----代码很清楚的不用写注释;
   (2)误导性注释;
    ----要么不写,要么就写准确;
   (3)循规式注释;
    ----要求每个函数都有javadoc式的注释、每个变量都有注释是愚蠢可笑的;
   (4)日志式注释;
    ----我们现在已经有了功能完备的版本控制工具,不要在每次编辑代码时都加包括日期、作者等信息的add、delete、modify信息;
   (5)右括号后面的注释;
    ----如果你发现由于嵌套太深而需要使用右括号后面的注释,你应该要做的是缩短函数;
   (6)确认不要的代码应该删除而不是注释掉;
    养成良好的变成习惯,做一个合格的,专业的编程人员。
  评论这张
 
阅读(79)| 评论(17)
推荐 转载

历史上的今天

在LOFTER的更多文章

评论

<#--最新日志,群博日志--> <#--推荐日志--> <#--引用记录--> <#--博主推荐--> <#--随机阅读--> <#--首页推荐--> <#--历史上的今天--> <#--被推荐日志--> <#--上一篇,下一篇--> <#-- 热度 --> <#-- 网易新闻广告 --> <#--右边模块结构--> <#--评论模块结构--> <#--引用模块结构--> <#--博主发起的投票-->
 
 
 
 
 
 
 
 
 
 
 
 
 
 

页脚

网易公司版权所有 ©1997-2017