Java包机制和Javadoc的使用

1.什么是包机制? 

  包(package)其实本质上就是一个文件夹,使用包是为了让相同类名的两个类可以使用,也就是操作系统中的文件夹,用来解决重名并且让相同的功能类放在同一个包,使开发更加有条理。

  注意:一般使用公司网址倒置名作为包名  com.baidu.Dao  com.baidu.Util等。

2.如何使用Javadoc命令生成说明文档

  1).命令行方式

  javadoc -encoding UTF-8 -charset UTF-8 类名.java

  2).IDEA 生成

  IDEA生成方式参考下面的链接,有详细说明什么生成文档。

  https://www.jianshu.com/p/0ddb0864e499

  记住要复制的是这全部一整个句子,否则会出现

            javadoc: 错误 - 非法的程序包名称

-encoding UTF-8 -charset UTF-8 -windowtitle "文档HTML页面标签的标题" -link http://docs.Oracle.com/javase/7/docs/api

      一定要有良好的习惯去书写说明文档,尽量说明每个类,方法的作用等,方便别人阅读文档。

 

建议:下载阿里巴巴开发手册,了解实际企业开发的手册

上一篇:兼容Javadoc的idea代码注释模板


下一篇:[转载文章]Google的Java编程风格指南(Java编码规范)