(JavaSE)Java基础语法3-包机制、JavaDoc

包机制

  • 为了更好地组织类,Java提供了包机制,用于区别类名的命名空间
  • 包语句的语法格式为:
    package pkg1[. pkg2[. pkg3...]];
    
  • 一般利用公司域名倒置作为包名,com.baidu.www
  • 为了能够使用某一个包的成员,我们需要在Java程序中明确导入该包,使用"import"语句可完成此功能
    import package1[.package2...].(classname|*);
    
    通配符"*"表示导入包下所有的类
    阅读:阿里巴巴开发手册

JavaDoc

  • javadoc命令是用来生成自己API文档的
  • 参数信息
    • @author作者名
    • @version版本号
    • @since指明需要最早使用的jdk版本
    • @param参数名
    • @return返回值情况
    • @throws异常抛出情况

Java内置的帮助文档https://docs.oracle.com/javase/8/docs/api/

  • 自动编译文档命令:javadoc -encoding UTF-8 -charset UTF-8 Doc.java
    其中Doc.java为需要生成API文档的文件名

posted @ 2021-03-15 21:10  Ziff  阅读(48)  评论(0)    收藏  举报