前言
今天的话来和大家聊聊注释那些事!
题外话:【我爱笨媳妇】
那些年我们追过的注释
我只记得在一个漆黑的夜晚,我被一个问题给困住了,就像一头困兽,在黑暗中不停地挣扎,我越是想逃脱,就被黑暗追的越紧。慢慢的,我感觉我在坠落,在坠落。突然,有人告诉我,我给你指点,原来是天上的神明!我心情激动,精神一振,她说,和我念:github大法好!我大声念了三遍,突然就在github上找到了类似的代码!然而,不忍直视的是,那人没写注释。
那些年,我们一起追过的注释啊!画风好像变得有点快啊!但是我想大家都被这样的问题坑过,所以呢,我们不能让后来的程序员在忍受这样的痛苦好吗?于是乎,今天,我们来谈谈注释!
注释是什么
还记得才学程序的时候,师傅们就教导我们,要写注释写注释啊,那时我们年少无知,现在才知道注释的重要性。
注释到底是什么东东?说白了就是对你的代码的一种解释,那肯定是有格式的,那么,让我们来看看吧?
首先来看看java的注释:
/**
* <li>这是一个测试的类,用来实现java连接redis</li>
*
* <pre>
* publicpublic static void main(String[] args) {
System.out.println("====================================" + "\n测试开始:");
new MyRedis().keyOperate();
}
* </pre>
*
* @version 1.0.1
* @author fulei.yang
*
*/
为了能够更加的清楚直观,我只粘贴了注释部分,我们可以看到。这个注释的话不同于我们在c语言里面学到的哪两种,当然,这是java独有的javadoc注释。
是专门用来说明我们的类或者方法的作用的。你懂的。其余的两种我就不多说了,嘿嘿
javadoc是什么
上面的话我们谈到了javadoc这种的注释方式,我们怎么还看到了好多类似于html标签的东西,那到底是什么?
其实的话,javadoc就是能将我们的代码中的注释提取出来的程序,当然,仅限于文档注释,我们提取出来的注释会作为文档交纳给别人看,有可能那个人会接受项目,也有可能那个人会在我们项目还没有做完的时候代为开发,那你想想,这个时候一个标准的文档是多麽的重要。
你想想,如果j我们的注释格式混乱,没有一点点的章法,我们把它导出成一个html格式的文档之后,我们的体验该是多麽的糟糕啊!
so,javadoc为我们提供了规范化注释格式的东西。那就是他也是支持一些html标签的。
常见的用在注释中的html标签
上面的话,我们讨论了在注释格式的重要性,也讨论了将注释的格式变好的方法。下面,我就带着大家一起去看看常用的标签吧~
“br” | 换行 |
“p” | 段落,自动换行 |
“pre” | 可以写一段注释代码,会保持代码的格式 |
“h*” | 目录的标签自然也是支持的 |
“code” | 实例代码的展示 |
“strong” | 加粗当然支持 |
“ol” | 有序列表无序列表都支持 |
”blockquote“ | 自动加上缩进没有 |
“hr” | 标签定义水平线 |
暂时就说这么多吧,再多人家都不会了,哈哈
其实,我们只要认真用好上述的标签,一定能够形成自己的风格。哈哈
下面,我们就来看个例子吧!
package test;
public class Test {
/**
* <li>
* <h3>这是测试的主程序</h3></li>
* <hr/>
* <h2>主要实现的功能如下:</h2><br/>
* <strong>打印</strong> <br/>
*
* @author 作者
* @param args
* {@link Test}
*/
public static void main(String[] args) {
System.out.println("hello world!");
}
}
上面的代码生成的注释效果是这样的!
总结
今天我们主要的讨论了java的文档注释中html标签的用法,希望大家看到以后,能够积极的用起来!
只要人人在注释上下点功夫,我相信代码的世界会更好懂!哈哈