许多人写代码时总不喜欢写注释,每个程序员如此,嘿嘿,我也一样
不过,话说回来,该写还是要写哦!没人会喜欢一个不写注释的程序员,当然,也没有一个喜欢写注释的程序员,今天,我们就来说说Java注释之一——Doc注释
我们知道,Java支持 3 种注释,分别是单行注释、多行注释和文档注释,我们来看看他们的样子
//单行注释
/*
多行注释
*/
/**
*@...
*....
*文档注释
*/
可能许多萌新不明白,写了这些注释有什么用呢?
其实是因为初学者的代码量少,没有注释也能快速查找、修改
当代码渐渐多了起来,注释就是一个好东西了,不仅是为了自己可以清晰明了看清代码,也是为了和你一起开发项目的成员一个方便
记住,改掉不写注释这种坏习惯!!!
那么,我们今天的主题来了,什么是Doc注释呢?
javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
javadoc命令是用来生API文档的,使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java
这些复杂理论不必去纠结,要培养一种思想,去了解、去理解、去深入、去改变它,去懂得他,死死揪住理论</