菜鸡的Java笔记 api 文档

package 包的用法
    为什么需要 package ?
        为了解决类之间的重名问题
        为了便于管理类;合适类位于合适的包
    
    package 怎么用?
        通常是类的第一句非注释性语句
        包名:域名倒着写即可,在加上模块名,并与内部管理类
        
    注意事项:
        写项目时都要加包,不要使用默认包
        com.gao 和 com.gao.car 这两个包没有包含关系,是两个完全 独立的包,只是逻辑上看起来后者是前者的一部分

生成自己的项目的API文档
    特殊的注释
        文档注释:/**

    使用JAVADOC生成API文档
        解决问题:代码和文档的分离
        
    常用的java注释标签:
        -@Author 作者
        -@version 版本
        -@param 参数
        -@return 返回值的含义
        -@throws 抛出异常描述
        -@deprecated 废弃,建议用户不在使用该方法

原文地址:https://www.cnblogs.com/mysterious-killer/p/10106845.html