疯狂java


您现在的位置: 疯狂软件 >> 新闻资讯 >> 正文

Java文档注释(4)—[疯狂java讲义]


 

        此处介绍的方法、构造器、属性等可能有点超前,读者可以参考后面的知识来理解如何定义方法、构造器、属性等,此处的重点是学会使用文档注释。
        由于文档注释是用于生成API文档的,而API文档主要用于说明类、方法、属性的功能。因此javadoc工具只处理文档源文件在类、接口、方法、属性、构造器和内部类之前的注释,忽略其他地方的文档注释。而且javadoc工具默认只处理以public或protected修饰的类、接口、方法、属性、构造器之前的文档注释。
        由于只有以public或protected修饰的内容才是希望暴露给别人使用的内容,而API文档主要是向使用者提供信息,围此javadoc默认只处理public或protected修饰的内容。如果开发者确实希望javadoc工具可以提取private修饰的内容,则可以在使用javadoc工具时增加-private选项。
        文档注释以斜线后紧跟两个星号(/**)开始,以星号后紧跟一个斜线(*/)作为结尾,中间部分全部都是文档注释,会被提取到API文档中。(未完.摘自[疯狂java讲义].李刚)