|
最近听到很多做程序员的小伙伴儿吐槽：从别人那儿接手的代码总是乱糟糟的，完全不知道写的什么！没有标记，没有说明，也没有一行注释，抓耳挠腮也看不懂！ 前程序员辞职留下的代码，谁也不愿意接手 这个时候，就需要万能的“注释”大大了！ 所谓注释，便是用自然语言对源代码中某些语句或方法进行说明。并且，注释的内容不会被编译器编译。你可以在源代码中添加任何你想要添加的说明，随便多少都可以，只要你不觉得啰嗦。 那么在Java中该如何书写注释呢？有以下三种方法： 一、单行注释 这是最常用的注释方式，注释内容从//开始，到该行结束。 举例：//定义了类的名称 二、多行注释 如果需要注释的内容比较多，一行写不完，如果在每一行注释中都使用//。 当然这种方法比较繁琐，看起来页面也不够简洁。这时候，就需要用到多行注释了。 /* *多行注释内容 */ 值得一提的是，多行注释还有一种不够简洁的注释方式，那就是嵌套在代码语句中。不过，实际应用的人很少。 三、文档注释 文档注释以/**开始，以*/结束，写入 javadoc文档，生成相应的Java源码的API（应用程序编程接口）文档。 常用的文档注释有以下几种： 注意： 1、多个作者使用多个@author标签，javadoc按照输入时间显示； 2、@param str the String 用来存放输出信息，这里表示输出的str是个整型； 3、@return true 执行成功，输出执行结果； 4、@since jdk1.6 表示编译该文件所需要的JDK环境为jdk1.6； （关于JDK的版本介绍会在后续的文章中展开，欢迎持续关注哈~） 5、@version 1.0 表示该注释版本的版本号是1.0； 6、@throws IOException 方法抛出了文件读取错误的异常。 7、@deprecated As of JDK1.1,replaced by 表示JDK1.1这个版本已经过期，取代它的是XX； 为了方便理解，小编自己敲了一段代码示例，希望能帮助大家理解！！ 到这里，Java里面的代码注释规则就讲完啦！喜欢的朋友们，欢迎来关注猿小花呦~~~ |
|
|
