From fdf6ccb4d2ce24aa4afc89e6aa08fbf4eb90f5ac Mon Sep 17 00:00:00 2001 From: sjsdfg <736777445@qq.com> Date: Sun, 7 Apr 2019 12:54:38 +0800 Subject: [PATCH] =?UTF-8?q?=E5=88=A0=E9=99=A4=E9=87=8D=E5=A4=8D=E5=86=85?= =?UTF-8?q?=E5=AE=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/notes/56. 为所有已公开的 API 元素编写文档注释.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/notes/56. 为所有已公开的 API 元素编写文档注释.md b/docs/notes/56. 为所有已公开的 API 元素编写文档注释.md index 06d9d8e..bed9645 100644 --- a/docs/notes/56. 为所有已公开的 API 元素编写文档注释.md +++ b/docs/notes/56. 为所有已公开的 API 元素编写文档注释.md @@ -315,9 +315,3 @@ public @interface ExceptionTest {   如果你遵循本项目中的指导原则,生成的文档应该提供对 API 的清晰描述。然而,唯一确定的方法,**是阅读 Javadoc 实用工具生成的 web 页面**。对于其他人将使用的每个 API,都值得这样做。正如测试程序几乎不可避免地会导致对代码的一些更改一样,阅读文档通常也会导致对文档注释的一些少许的修改。   总之,文档注释是记录 API 的最佳、最有效的方法。对于所有导出的 API 元素,它们的使用应被视为必需的。 采用符合标准惯例的一致风格 。请记住,在文档注释中允许任意 HTML,但必须转义 HTML 的元字符。 - -  本条目中描述的约定涵盖了基本内容。尽管撰写本文时已经有 15 年的历史,但编写文档注释的最终指南仍然是《 How to Write Doc Comments》[Javadoc-guide]。 - -  如果你遵循本项目中的指导原则,生成的文档应该提供对 API 的清晰描述。然而,唯一确定的方法,**是阅读 Javadoc 实用工具生成的 web 页面**。对于其他人将使用的每个 API,都值得这样做。正如测试程序几乎不可避免地会导致对代码的一些更改一样,阅读文档通常也会导致对文档注释的一些少许的修改。 - -  总之,文档注释是记录 API 的最佳、最有效的方法。对于所有导出的 API 元素,它们的使用应被视为必需的。 采用符合标准惯例的一致风格 。请记住,在文档注释中允许任意 HTML,但必须转义 HTML 的元字符。 \ No newline at end of file