`
TonyLian
  • 浏览: 402115 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

【第28条】为所有导出的API元素编写文档注释

阅读更多

    Javadoc真是个好东西。它简直太奇妙了,简直就是“懒人乐”。

 

    其实,不仅仅是受“懒人”欢迎,它还有标准化、一元化等其他好处...

 

    那么,懒人们可听好了:为了正确地编写API文档,你必须在每一个被导出的类、接口、构造函数、方法和域声明之前加上文档注释。每一个方法的文档注释应该简洁地描述出它和使用者之间的约定。

 

    具体的@语法,这里就不介绍了。

 

 

 

【Effective Java 学习笔记】系列连载专题请见:
http://tonylian.iteye.com/categories/64208

分享到:
评论

相关推荐

    swagger导出静态API文档工具

    Swagger导出静态API文档工具是基于Swagger的一个实用工具,它是一个Maven工程,这意味着我们可以利用Maven的构建生命周期来自动化文档的生成过程。 首先,让我们了解Maven。Maven是一个项目管理工具,它通过读取...

    JavaDoc生成API文档(powernode document)(源代码和导出的文档)

    JavaDoc生成API文档(powernode...Java中有三种注释方法://单行注释、/多行注释/和/文档注释/,其中第三种专为JavaDoc设计,可以被JDK内置的JavaDoc工具支持和处理。我们可以通过Eclipse来实现Java文件的API文档生成。

    Apifox导出word版接口文档-模板

    Apifox是一款功能强大且灵活的API设计和文档管理工具,支持多种格式的导出,包括Word版接口文档。在这个模板中,我们可以看到一个基本的Word版接口文档结构,包括标题、描述、标签和部分内容。 标题: Apifox导出...

    通过spring插件生成api注释文档

    在IT行业中,API文档是软件开发过程中的重要组成部分,它为开发者提供了清晰的接口使用指南。Spring框架作为Java领域中最流行的开发工具之一,提供了一系列插件来帮助我们自动化这个过程,使得API注释文档的生成变得...

    webapi文档生成,快速生成WebApi说明文档

    WebAPI文档生成是一个重要的开发工具,它可以帮助开发者快速创建、更新和管理WebAPI接口的说明文档。这个工具的出现极大地方便了团队协作,确保所有成员对API接口的一致理解和使用,同时也便于非开发人员如测试人员...

    一款C#编写CSDN博客导出工具,导出为MarkDown文档 炒鸡简单.zip

    标题中的“C#编写CSDN博客导出工具”指的是使用C#编程语言开发的一款软件应用,该应用专为CSDN(China Software Developer Network)博客用户设计,目的是将CSDN博客的内容导出为Markdown格式的文档。Markdown是一种...

    跨平台跨语言API文档编写工具.rar(附带教程)

    标题中的“跨平台跨语言API文档编写工具”指的是一个能够帮助开发者生成适用于多种操作系统(如Windows、Linux、macOS)和编程语言(如Java、Python、C++等)的API文档的软件。这类工具通常采用一种标准化的格式,如...

    PowerDesigner将PDM导出生成WORD文档的方法

    - 最后一步是将报告导出为Word文档。这一步通常在PowerDesigner的菜单栏或工具栏中有明确的操作选项。导出完成后,即可获得一份完整的Word文档,其中包含了所选PDM的所有相关信息。 #### 四、注意事项 1. **格式...

    WPS API帮助文档

    总结来说,WPS API为开发者提供了强大且灵活的工具,使其能够充分利用WPS Office的功能进行定制化开发,提升办公自动化水平,满足不同场景下的需求。通过深入理解和熟练运用WPS API,开发者可以构建高效、个性化的...

    java报表API源代码(程序数据集、自定义函数和导出API)

    Java报表API源代码主要涵盖了FineReport工具的程序数据集、自定义函数和导出API的实现,旨在帮助开发者深入了解报表工具的内部工作原理,掌握二次开发技能,以应对各种个性化的业务需求。FineReport是一款强大的Java...

    Awvs API接口文档

    整理网络资源,根据网络上的相关文档结合自己的实际操作整理的AWVS11的API接口文档,官方的API接口文档是商务付费的,所以只能自己整理。我所使用的接口测试工具为curl,curl的具体安装和相关参数请度娘。核心参考...

    mysql数据库文档导出

    数据库文档导出数据库文档导出数据库文档导出数据库文档导出数据库文档导出数据库文档导出数据库文档导出数据库文档导出数据库文档导出数据库文档导出数据库文档导出数据库文档导出数据库文档导出数据库文档导出...

    springboot项目中json导出成标准接口文档到word(swagger样式)

    根据业务需求需要,需要将json格式的api信息【比如postman导出接口...该平台是将一些好的第三方平台接口接入进来,供用户使用,每个用户下有可以使用的接口,可以根据需要,将这些api勾选导出成标准接口文档的样式。

    SQL SERVER自动导出Word数据库文档

    在SQL SERVER环境中,有时我们需要将数据库的信息以报告的形式呈现,比如导出为Word文档,方便阅读和分享。"SQL SERVER自动导出Word数据库文档"这一功能就满足了这样的需求。这个功能主要应用于SQL SERVER 2000、...

    vs c# 文档注释 生成 源码

    这样,在编译项目时,VS会根据源代码中的三斜线注释(///)生成一个XML文件,其中包含了所有公共类型的API文档。 生成的XML文件可以用于创建API参考文档,例如通过Sandcastle、docfx等工具。但这个描述中提到的是一...

    导出Excel文档.

    在IT行业中,尤其是在数据处理和报告生成的场景下,导出Excel文档是一项常见的任务。Excel作为微软 Office 套件中的重要组件,以其强大的数据管理、分析和可视化能力深受程序员和业务人员的喜爱。本文件主要关注如何...

    Python-confluencedumper通过API能递归样的将Confluence空间和页页都导出

    这种递归方式确保了所有子页面和附件都能被正确地捕获和导出。 1. **Confluence REST API**:Confluence提供了一套全面的API,允许开发者使用HTTP请求进行读写操作。这些API包括获取空间信息、页面内容、版本历史、...

    tsgo:使用TypeScript编写库和导出API文档的命令行工具

    tsgo使用TypeScript编写库和导出API文档的命令行工具。快速开始$ npm install -g @tybys/tsgo$ mkdir mylib$ cd mylib$ tsgo gen

    快速生成某个lua文件对外的api

    在IT行业中,API(应用程序接口)是软件系统之间交互的关键元素。当提到“快速生成某个lua文件对外的API”时,我们通常指的是为Lua脚本创建一个清晰、规范的接口,使得其他程序或脚本可以方便地调用其功能。在...

Global site tag (gtag.js) - Google Analytics