优秀程序员第一步,养成写注释的好习惯!

在编写程序的时候,可以为程序代码加上一些注释(Comment),说明或记录程序中的一些要注意的是想。Java语言是用来与计算机沟通的语言,而注释的作用则是与开发人员沟通。

 
源代码文件中被标注为注释的文字,编译器不会去处理它,所以在文字中编写的任何东西,对编译出来的程序不会有任何影响。在Java中可以用两种方式为程序加上注释。
 
/* 
* 作者:陶陶滔滔涛
* 作用:注释的用法
* 日期:2012年3月6日
*/
public class HelloWorld {
public static void main(String[] args) {
    //输出HelloWorld,然后换行
    System.out.println(“HelloWorld.”);
  }
}
/* 和 */用来包括跨行的注释文字。通常开发人员为了让注释文字看来比较整洁清晰,中间还会使用一些*来排版,只要记得使用多行注释时,是以结束注释文字即可,所以不能用嵌套方式来编写多行注释。例如下面的方式是不对的。

1 /* 注释文字1
2   /*
3     注释文字2
4   */
5 */

编译器在处理前面的编写方式时,会以为倒数第2个*/就是注释的结束点,因而对最后一个*/就会认为是错误的符号,这就会出现编译错误的信息。

//则可以用来编写单行注释,在//之后的该行文字都被视为注释文字,多行注释可以包含单行注释。例如:

1 /* 注释文字1
2   //注释文字2
3 */
 
注释的编写时机与内容并没有什么特别的规定,以清晰易懂为主。注释的目的在于说明程序,是给开发人员看的,您可以使用注释在程序中写下重要事项,日后作为备忘或者是方便其他开发人员了解您的程序内容。
 
注释的另一个作用则是暂时注销某些语句。当您觉得程序中某些语句有问题,可以使用注释标示起来,这样编译器就不会去处理。


posted @ 2012-03-06 14:06  香蕉煎牛腩  阅读(485)  评论(0编辑  收藏  举报