有关代码注释

  1. 对类的注释,在开头进行注释说明,信息包括:作者、创建日期、用途、修改日期、修改人员
  2. 对方法的注释,信息包括:功能、参数,以及返回值
  3. 对代码片段的注释,主要为小块代码段作注释,简短描述
  4. 对代码行的注释,主要紧跟在代码行后成作注释,简短描述
  5. 对待实现代码的注释,简短描述 //TODO: what

注释时,注意工整,通常使用空格作为格式调整

posted @ 2011-11-26 23:46  Yu  阅读(173)  评论(0编辑  收藏  举报