首页 > 代码库 > 程序员的专属语言-----注释(04)

程序员的专属语言-----注释(04)

  记得以前有个笑话,说一个程序员和他的朋友去吃饭,他拿着本记录菜名,几个人商量之后决定有一个菜不点了。过了一会儿上菜的时候还是上来了,大家都问为什么,服务员拿来菜单一看:    //鱼香肉丝。对于不懂程序的服务员,她显然没有明白这两个斜杠是什么意思 ,所以就闹出了这个笑话。在程序开发中,如果一味的写程序可执行的代码,运行起来可能没有问题,但是后续更改或维护就比较吃力,毕竟人直接看程序难度是有点大的,所以为了方便在以后阅读程序或者别人阅读程序时能比较容易读懂,为程序添加注释是必要的。听人说,一个完整的程序,注释应当占到代码总量的百分之四十甚至更多,可想注释对于程序是多么重要。

  java语言中注释分为三种,最常用的也就是上面笑话中程序员用的"//",它用来注释一行代码,通常是解释一个语句,解释定义变量的用意等.如

    //这是一个输入语句

        System.out.println("Hello World");

  第二种是用来注释多行代代码,通常解释一个方法,或是一个类的时候可以使用,格式为:

    /**

      这是主方法,是程序的入口

      每个java程序要想独立运行都要有一个主方法

    */

    public static void main(String[] args){

    }

  第三种注释是为了制作API特有的一种注释,java语言很庞大,制作说明文档很有必要,所以文档注释就是用来生成说明文档的.其格式为:

  /**

  *这是文档注释,通过文档注释,可生成API

  */

  它可以通过java的一个命令javadoc解析生成API,具体操作以后再讲.有了注释之后 ,程序员与程序员沟通更方便,可以说注释是程序员间一门专属的语言了吧...

程序员的专属语言-----注释(04)