码迷,mamicode.com
首页 > 其他好文 > 详细

关于注释

时间:2015-04-18 23:45:38      阅读:143      评论:0      收藏:0      [点我收藏+]

标签:

在编写程序时,应当给程序添加一些注释,用于说明某段代码的作用,或者说明某个类的用途,某个方法的功能,以及该方法的参数和返回值类型和意义等。

很多初学者开始学习编程语言时,会很努力写程序,但不太注意添加注释,他们认为添加注释是一件浪费时间,而且没有意义的事情。经过一段时间的学习,他们写出了一些不错的小程序,如一些游戏,工具软件等。在经过一段时间的学习,他们开始意识到当初写的程序在结构上有很多不足,需要重构。于是他们打开源代码,以为可以很轻松的改写源代码,但这时他们发现理解原来写的代码非常困难,很难理解原来的思路。

为什么要添加程序注释呢?至少有如下三方面的考虑:

  • 永远不要过于相信自己的理解能力
  • 可读性第一,效率第二
  • 代码即文档

程序注释是源代码的一个重要组成部分,对于一份规范的程序源代码而言,注释应当占到源代码的1/3以上。……………………

关于注释

标签:

原文地址:http://www.cnblogs.com/shengjie123/p/4438358.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!