按照这些简单的指南生成干净、动态的文档。 Javadoc到底是什么？ 文档是开发人员最好的朋友。但是，该文档最初是如何创建的呢？对于许多Java程序，答案是Javadoc。 Javadoc是Oracle拥有的一个易于使用的工具，它解析您的Java代码并生成干净的API文档，您和其他人可以使用这些文档来更好地理解您的程序。以下指南将准确地教您如何编写Javadoc理解的注释以及如何访问所述文档。 Javadoc注释的一般格式 要将Javadoc注释与标准Java注释区分开来，请在块注释的开头使用两个星号而不是一个星号。singlelinecommentstandardblockcommentJavadoccomment 注意：单行Javadoc注释不支持语法。 这些注释通常由两个不同的部分组成：第一个是对注释所属的字段、方法或类的一般描述，第二个是由符号表示的标签列表，为文档提供诸如返回类型、相关文件或版本信息。Thisisanexamplemethodthatdoessomethingsuper，superimportant。returnintthrowsException 注意：上面示例中两个部分之间的空格在技术上不是必需的，但包含它是一种很好的做法。 此外，Javadoc注释行有80个字符的限制。 我应该在哪里包含Javadoc注释？ Javadoc注释主要分为三类：现场评论方法注释课堂评论 一个好的经验法则是为所有类和方法创建详细的Javadoc注释，但不要注释大多数字段，除非它们经常以不明显的方式使用或名称模糊。 字段注释AreallyimportantvariableprivateStringsuperImportant； 方法注释Printsaspecifiednumberandreturnsasmileyface。paramnumintegertobeprintedparamshouldPrintwhetherornottoprintthenumberreturnsmileyfaceStringexampleMethod（intnum，booleanshouldPrint）｛if（shouldPrint）System。out。print（Yournumberis：num）；return：）；｝ class评论Doesnothing，butisabeautifulexample。authorSophiaHubscherversion1。0publicclassexampleClass｛｝ 注意：Javadoc注释遵循继承规则，这意味着不需要为继承的类、方法或字段编写Javadoc注释。 块与内联标签 到目前为止，我们看到的所有标签都是tag形式的，但也有很多其他形式的｛tag｝。这两者之间的区别在于，虽然第一种类型（块标签）始终是其代码行中的唯一信息，但括号内的标签（内联标签）与其他字符串、标签和信息一起使用。Examplemethodthatdoessomethingreallycoolandexciting。deprecatedAsofv2。0，replacedby｛linkotherExample（int）｝ Javadoc标记 所以您知道如何构建Javadoc注释，但是所有这些标签呢？这是它们的列表，从最常用的开始。 键：名称语法解释参数paramparameterName〔参数描述〕在方法注释中用于解释其每个参数。如示例方法注释中所示，每个参数使用一个参数标记。返回return〔返回值说明〕除非返回类型为void，否则在方法注释中使用。见见参考see后面可以跟一个字符串、外部链接或对代码另一部分的引用。thethreetypesofseetagsseeThisisanexamplestring。seeLabelseepackage。classmemberlabel作者作者姓名在类注释中使用以指定作者。版本版本迭代用于跟踪代码的版本。自从自日期类似于版本，但跟踪日期而不是版本号。抛出抛出异常表示方法抛出的异常。可以替换为exception，但throws是标准的。弃用不推荐使用的文本表示不应再使用的已弃用代码。｛代码｝｛代码文本｝以代码字体显示文本。 ｛codeHeressometext！｝会变成：Heressometext！进入这个这里有一些文字！在您的文档中。｛链接｝｛linkpackage。classmember标签｝以代码字体将链接插入到文档中。｛linkplain｝｛linkplainpackage。classmember标签｝以纯字体将链接插入到文档中。｛docRoot｝｛docRoot｝提供根目录的相对路径。｛inheritDoc｝｛inheritDoc｝从最近的可继承类或可实现接口继承文档。连载序列描述用于默认可序列化字段序列数据serialData描述当通过writeObject（）或writeExternal（）方法写入数据时使用。序列字段serialField名称类型描述为ObjectStreamField组件提供注释。｛值｝｛valuepackage。classfield｝显示常量字段的值。 提示：检查是否有任何方法可以自动生成Javadoc注释的大纲，例如JDeveloper的SourceAddJavadocComments工具！ 标签应该按任何特定顺序排列吗？ 是的！根据Javadoc的所有者Oracle的说法，这是标签的首选顺序：authorversionparamreturnthrowsseesinceserialdepreciated 因为内联标签不需要自己的代码行，所以只要在适当的地方使用它们，不用担心这个顺序。 所有的HTML是怎么回事？ 为了让您对文档的外观和感觉有所控制，Javadoc为您提供了使用HTML标记来设置文本样式的选项！h1Funheading！h1pHeresasupercooldescriptionofmysupercoolclass！authorSophiaHubscherversion1。0 关于对齐的说明 尽管在垂直对齐代码方面我们都有自己的偏好，但对于Javadoc，任何事情都会发生。所以，做任何让你的船漂浮的事情。Feelfreetodothis！paramnumberareallycoolnumberparamcoolerNumberanevencoolernumberreturnthesum（a。k。athecoolestnumberever）Orthis！paramnumberareallycoolnumberparamcoolerNumberanevencoolernumberreturnthesum（a。k。athecoolestnumberever） 访问文档 你做到了！您的代码已被注释，您已准备好查看您的全新文档！但是怎么做？ 按照以下步骤获取您最喜欢的IDE，生成文档后，您始终可以通过导航到新生成的index。html文件来查看它。 开发人员 构建Javadoc 智能 工具生成Javadoc确定 编辑器内：将鼠标悬停在您的代码上，然后选择F1（或CtrlQ用于WindowsLinux）。 jGRASP 文件生成文档 蚀 项目生成Javadoc完成 网豆 窗口IDE工具Javadoc文档 编辑器内：将鼠标悬停在您的代码上，然后为WindowsLinux选择CtrlShiftSpace或为macOS选择CmdShift。 蓝J 工具产品文档 命令行 如果您不想使用IDE，Oracle文档提供了许多控制台内文档生成示例。 最后的想法 虽然这个过程一开始可能看起来很乏味，但要为干净、可访问的文档付出很小的代价。 快乐评论！
切尔西新老板基本确认为美国富豪，英超恐成美国人的天下近日据《每日邮报》爆料，美国富豪托德伯利即将成为切尔西的新老板，如今托德伯利财团成为切尔西的优先竞购方，入主切尔西只是时间问题。今年3月份，切尔西老板阿布宣布出售俱乐部。……花椒直播母公司花房集团二次递表，3年亏损10亿元，周鸿祎持股5月1日消息，花椒直播的母公司花房集团在4月29日第二次向港交所递交了上市招股书。他们曾在2021年10月25日首次递表，但那份材料在6个月后已经失效。据花房集团的招股书……北京突发！又一地高风险，正式启用小汤山方舱医院！信息量很大！中国基金报记者吴羽涉嫌非法汇款小米遭印度政府扣押约48亿元印度当局今天表示，调查发现中国智能手机制造商小米集团以假冒成支付版权费的方式非法汇款给外国实体，当局……飞花令五一的诗句全集庆祝五一劳动节诗词向全国劳动人民致敬飞花令本是中国古代一种喝酒时用来罚酒助兴的酒令，飞花一词出自唐代诗人韩翃《寒食》诗中的春城无处不飞花。在这个特殊的假期，家长们不如和孩子一起玩玩飞花令，不仅能让孩子掌握更……圆的联想作文400字圆在生活中无处不在，钟表、太阳、盘子、硬币等都有圆的身影。有人喜欢圆圆的太阳，因为它很温暖；有人喜欢足球，因为它能带给人们快乐和健康。而我却喜爱晶莹剔透的露珠。露珠是万物……家乡的莲藕小学作文我的家乡巴河镇是一个坐落在长江之滨的水乡小镇。那里不但有美丽的湖光山色，而且有丰富的物产资源，最闻名的要数莲藕了。说起家乡的莲藕还有一个动人的故事。听爷爷的爷爷说：从前有……粗心大意惹的祸二年级作文这几天，大妈要我发条短信给大姐，我想：为何不打电话哪？我一边想，一边飞快地跑回家，我打开电脑，上了QQ，给姐姐发话：姐，大妈让你好好读书。不必回家看妈妈。O，完成！玩手机去了！……山寨明星们的娱圈冒险擦边球花钱变脸，有人轻松年入百万以前网络不发达，电视节目上曾兴起过一阵明星模仿秀的风潮，收视率倍儿高。但那会儿也只是看个热闹，上完节目，这些模仿者也就泯然众人矣。如今情况大不同，这些山寨明星找到了……夏天到了，看当红明星刘涛等女明星如何防晒妙招大揭秘夏天到了看刘涛等女明星如何防晒妙招大揭秘！今现场传媒编辑赵成成20220501马上夏天了，相信现在已经不少女盆友在研究防晒了吧，不仅要涂抹防晒，外出的时候还要喷防晒……在八卦最多的女明星中，杨幂很难逃脱榜首的位置娱乐内容多种多样，点击率最高的是八卦。那么，在娱乐业，谁有更多的流言蜚语？说一个女明星，杨幂绝对很难逃脱榜首的位置在出演《仙剑奇侠传三》时，媒体就透露出杨幂与胡歌有关系。……新年作文作文150字年味儿盼望着，盼望着，眼前渐渐出现了一片喜气洋洋的红，新年的脚步声越来越近，浓浓的年味儿在大街小巷弥漫。瞧！孩子们换上了新衣，小伙伴们嬉戏着，老人们互相登门拜年，脸上堆满了幸福……没有电的日子作文400字20xx年的7月，烈日炎炎，热浪滚滚，连树上的蝉都不叫了，真是太热了为了避暑，我就跑去弟弟阳阳家玩。阳阳家在6楼，阁楼上都是玩具，我们一会儿玩乐高，一会儿玩枪战，玩得汗流夹背，……