巨久科技网站建设,培训心得体会800字,中山网站建设价格低,网站开发流程ppt朋友你好#xff0c;用使用 javadoc 标记可以做到。具体说明如下#xff1a;#xff1a;javadoc 标记是插入文档注释中的特殊标记#xff0c;它们用于标识代码中的特殊引用。javadoc 标记由“”及其后所跟的标记类型和专用注释引用组成。记住了#xff0c;三个部分——、标…朋友你好用使用 javadoc 标记可以做到。具体说明如下javadoc 标记是插入文档注释中的特殊标记它们用于标识代码中的特殊引用。javadoc 标记由“”及其后所跟的标记类型和专用注释引用组成。记住了三个部分——、标记类型、专用注释引用。不过我宁愿把它分成两部分 和标记类型、专用注释引用。虽然 和 标记类型之间有时可以用空格符分隔但是我宁愿始终将它们紧挨着写以减少出错机会。javadoc 标记有如下一些标记 用于 作用author 对类的说明 标明开发该类模块的作者version 对类的说明 标明该类模块的版本see 对类、属性、方法的说明 参考转向也就是相关主题param 对方法的说明 对方法中某参数的说明return 对方法的说明 对方法返回值的说明exception 对方法的说明 对方法可能抛出的异常进行说明下面详细说明各标记。1。 see 的使用see 的句法有三种see 类名see #方法名或属性名see 类名#方法名或属性名类名可以根据需要只写出类名 (如 String) 或者写出类全名 (如 ng。String)。那么什么时候只需要写出类名什么时候需要写出类全名呢如果 java 源文件中的 import 语句包含了的类可以只写出类名如果没有包含则需要写出类全名。 ng 也已经默认被包含了。这和 javac 编译 java 源文件时的规定一样所以可以简单的用 javac 编译来判断源程序中 javac 能找到的类javadoc 也一定能找到javac 找不到的类javadoc 也找不到这就需要使用类全名了。方法名或者属性名如果是属性名则只需要写出属性名即可如果是方法名则需要写出方法名以及参数类型没有参数的方法需要写出一对括号。如成员类型 成员名称及参数 see 句法属性 number see number属性 count see count方法 count() see count()方法 show(boolean b) see show(boolean)方法 main(String[] args) see main(String[])有时也可以偷懒假如上例中没有 count 这一属性那么参考方法 count() 就可以简写成 see count。不过为了安全起见还是写全 see count() 比较好。see 的第二个句法和第三个句法都是转向方法或者属性的参考它们有什么区别呢第二个句法中没有指出类名则默认为当前类。所以它定义的参考都转向本类中的属性或者方法。而第三个句法中指出了类名则还可以转向其它类的属性或者方法。关于 see 标记我们举个例说明。由于 see 在对类说明、对属性说明、对方法说明时用法都一样所以这里只以对类说明为例。/*** see String* see ng。StringBuffer* see #str* see #str()* see #main(String[])* see Object#toString()*/public class TestJavaDoc {}生成的文档的相关部分如下图String 和 StringBuffer 都是在 ng 包中由于这个包是默认导入了的所以这两个类可以直接写类名也可以写类全名。str、str() 为同名属性和方法所以方法名需要用 () 区分。main 是带参数的方法所以在 () 中指明了参数类型。toString() 虽然在本类中也有 (从 Object 继承的)但我们是想参考 Object 类的 toString() 方法所以使用了 Object#toString()。奇怪的是为什么其中只有 str、str() 和 main(String[]) 变成了链接呢那是因为编译时没有把 ng 包或者 Stirng、StringBuffer、Object 三个类的源文件一起加入编译所以生成的文档没有关于那三个类的信息也就不可以建立链接了。后面讲解 javadoc 编译命令的时候还会详细说明。上例中如果去把类中的 str 属性去掉那么生成的文档又会有什么变化呢你会发现原来是 str, str()而现在变成了 str(), str()因为 str 属性已经没有了所以 str 也表示方法 str()。2。 使用 author、version 说明类这两个标记分别用于指明类的作者和版本。缺省情况下 javadoc 将其忽略但命令行开关 -author 和 -version 可以修改这个功能使其包含的信息被输出。这两个标记的句法如下author 作者名version 版本号其中author 可以多次使用以指明多个作者生成的文档中每个作者之间使用逗号 (,) 隔开。version 也可以使用多次只有第一次有效生成的文档中只会显示第一次使用 version 指明的版本号。如下例/*** author Fancy* author Bird* version Version 1。00* version Version 2。00*/public class TestJavaDoc {}生成文档的相关部分如图从生成文档的图示中可以看出两个 author 语句都被编译在文档中生成了作者列表。而两个 version 语句中只有第一句被编译了只生成了一个版本号。从图上看作者列表是以逗号分隔的如果我想分行显示怎么办另外如果我想显示两个以上的版本号又该怎么办——我们可以将上述两条 author 语句合为一句把两个 version 语句也合为一句author FancyBirdversion Version 1。00Version 2。00结果如图我们这样做即达到了目的又没有破坏规则。author 之后的作者名和 version 之后的版本号都可以是用户自己定义的任何 HTML 格式所以我们可以使用标记将其分行显示。同时在一个 version 中指明两个用分隔的版本号也没有破坏只显示第一个 version 内容的规则。3。 使用 param、return 和 exception 说明方法这三个标记都是只用于方法的。param 描述方法的参数return 描述方法的返回值exception 描述方法可能抛出的异常。它们的句法如下param 参数名 参数说明return 返回值说明exception 异常类名 说明每一个 param 只能描述方法的一个参数所以如果方法需要多个参数就需要多次使用 param 来描述。一个方法中只能用一个 return如果文档说明中列了多个 return则 javadoc 编译时会发出警告且只有第一个 return 在生成的文档中有效。方法可能抛出的异常应当用 exception 描述。由于一个方法可能抛出多个异常所以可以有多个 exception。每个 exception 后面应有简述的异常类名说明中应指出抛出异常的原因。需要注意的是异常类名应该根据源文件的 import 语句确定是写出类名还是类全名。 示例如下public class TestJavaDoc {/*** param n a switch* param b excrescent parameter* return true or false* return excrescent return* exception ng。Exception throw when switch is 1* exception NullPointerException throw when parameter n is null*/public boolean fun(Integer n) throws Exception {switch ( Value()) {case 0:break;case 1:throw new Exception(Test Only);default:return false;}return true;}}使用 javadoc 编译生成的文档相关部分如下图可以看到上例中 param b excrescent parameter 一句是多余的因为参数只是一个 n并没有一个 b但是 javadoc 编译时并没有检查。因此写文档注释时一定要正确匹配参数表与方法中正式参数表的项目。如果方法参数表中的参数是 a文档中却给出对参数 x 的解释或者再多出一个参数 i就会让人摸不着头脑了。exceptin 也是一样。上例程序中并没有抛出一个 NullPointerException但是文档注释中为什么要写上这么一句呢难道又是为了演示这不是为了演示描述多余的异常也能通过编译而是为了说明写异常说明时应考运行时 (RunTime) 异常的可能性。上例程序中如果参数 n 是给的一个空值 (null)那么程序会在运行的时候抛出一个 NullPointerException因此在文档注释中添加了对 NullPointerException 的说明。上例中的 return 语句有两个但是根据规则同一个方法中只有第一个 return 有效其余的会被 javadoc 忽略。所以生成的文档中没有出现第二个 return 的描述。讲到这里该怎么写文档注释你应该已经清楚了下面就开始讲解 javadoc 的常用命令。运行 javadoc -help 可以看到 javadoc 的用法这里列举常用参数如下用法javadoc [options] [packagenames] [sourcefiles]选项-public 仅显示 public 类和成员-protected 显示 protected/public 类和成员 (缺省)-package 显示 package/protected/public 类和成员-private 显示所有类和成员-d 输出文件的目标目录-version 包含 version 段-author 包含 author 段-splitindex 将索引分为每个字母对应一个文件-windowtitle 文档的浏览器窗口标题javadoc 编译文档时可以给定包列表也可以给出源程序文件列表。例如在 CLASSPATH 下有两个包若干类如下fancy。Editorfancy。Testfancy。editor。ECommandfancy。editor。EDocumentfancy。editor。EView这里有两个包 (fancy 和 fancy。editor) 和 5 个类。那么编译时 (Windows 环境) 可以使用如下 javadoc 命令javadoc fancy\Test。java fancy\Editor。java fancy\editor\ECommand。java fancy\editor\EDocument。java fancy\editor\EView。java这是给出 java 源文件作为编译参数的方法注意命令中指出的是文件路径应该根据实际情况改变。也可以是给出包名作为编译参数如javadoc fancy fancy。editor用浏览器打开生成文档的 ml 文件即可发现两种方式编译结果的不同如下图用第二条命令生成的文档被框架分成了三部分包列表、类列表和类说明。在包列表中选择了某个包之后类列表中就会列出该包中的所有类在类列表中选择了某个类之后类说明部分就会显示出该类的详细文档。而用第一条命令生成的文档只有两部分类列表和类说明没有包列表。这就是两种方式生成文档的最大区别了。下面再来细说选项。-public、-protected、-package、-private 四个选项只需要任选其一即可。它们指定的显示类成员的程度。它们显示的成员多少是一个包含的关系如下表-private (显示所有类和成员)-package (显示 package/protected/public 类和成员)-protected (显示 protected/public 类和成员)-public (仅显示 public 类和成员)-d 选项允许你定义输出目录。如果不用 -d 定义输出目录生成的文档文件会放在当前目录下。-d 选项的用法是-d 目录名目录名为必填项也就是说如果你使用了 -d 参数就一定要为它指定一个目录。这个目录必须已经存在了如果还不存在请在运行 javadoc 之前创建该目录。-version 和 -author 用于控制生成文档时是否生成 version 和 author 指定的内容。不加这两个参数的情况下生成的文档中不包含版本和作者信息。-splitindex 选项将索引分为每个字母对应一个文件。默认情况下索引文件只有一个且该文件中包含所有索引内容。当然生成文档内容不多的时候这样做非常合适但是如果文档内容非常多的时候这个索引文件将包含非常多的内容显得过于庞大。使用 -splitindex 会把索引文件按各索引项的第一个字母进行分类每个字母对应一个文件。这样就减轻了一个索引文件的负担。-windowtitle 选项为文档指定一个标题该标题会显示在窗口的标题栏上。如果不指定该标题而默认的文档标题为“生成的文档(无标题)”。该选项的用法是-windowtitle 标题标题是一串没有包含空格的文本因为空格符是用于分隔各参数的所以不能包含空格。同 -d 类似如果指定了 -windowtitle 选项则必须指定标题文本。到此为止Java 文档和 javadoc 就介绍完了。javadoc 真的能让我们在 Java 注释上做文章——生成开发文档。Trackback:。全部
