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

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

阅读更多

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

 

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

 

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

 

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

 

 

 

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

分享到:
评论

相关推荐

    delphi 开发经验技巧宝典源码

    0111 如何将二进制转换为八进制 73 0112 如何将二进制转换为十进制 75 0113 如何将二进制转换为十六进制 76 0114 如何将十进制转换为二进制 77 0115 如何将十进制转换为十六进制 78 0116 如何将十六进制...

    精通WindowsAPI.pdf

    第1章 Windows应用程序开发入门..........................................................................................16 1.1 第一个实例程序...............................................................

    Access+2000中文版高级编程

    第二部分 操作和显示数据 179 第8章 用查询最大限度地利用数据 181 8.1 Access使用查询的位置 181 8.1.1 在窗体或报表的记录源属性中使用查询 182 8.1.2 设置用户使用查询的权限 183 8.1.3 使用命名约定和...

    Access 2000中文版高级编程(part1)

    第二部分 操作和显示数据 179 第8章 用查询最大限度地利用数据 181 8.1 Access使用查询的位置 181 8.1.1 在窗体或报表的记录源属性中使用查询 182 8.1.2 设置用户使用查询的权限 183 8.1.3 使用命名约定和查询...

    MyEclipse 6 Java EE 开发中文手册

    #### 第二章:安装配置开发环境 **2.1 JDK的下载与安装** - **下载JDK**:首先访问Oracle官网下载JDK 6,选择适合的操作系统版本进行下载。 - **安装JDK**:按照提示完成JDK的安装过程。 - **配置环境变量**:设置...

    photoshop 插件开发指南

    该文档主要基于 Thomas Knoll、Mark Hamburg 和 Zalman Stern 的早期作品编写,并得到了 David Corboy、Kevin Johnston、Sean Parent 和 Seetha Narayanan 的补充贡献。文档的编辑工作由 Dave Wise 完成。 文档版本...

    java正式课程.md

    - **文档注释**:`/** ... */`,可用于生成API文档。 #### 九、项目导出 - **步骤**:在Eclipse中,选择项目->右键->Export,然后根据提示完成导出过程。 #### 十、变量与运算符 - **数据类型** - **基本数据...

    JAVA上百实例源码以及开源项目源代码

    Java局域网通信——飞鸽传书源代码 28个目标文件 内容索引:JAVA源码,媒体网络,飞鸽传书 Java局域网通信——飞鸽传书源代码,大家都知道VB版、VC版还有Delphi版的飞鸽传书软件,但是Java版的确实不多,因此这个Java...

    MyEclipse开发手册之Java篇

    - **注释和取消注释**:常用快捷键介绍。 - **手工和自动编译**:如何设置Eclipse自动编译选项。 - **直接粘贴Java源码为类文件**:一种快速创建新类的方法。 - **复制项目中的文件**:如何高效地复制文件。 - **...

    易语言程序免安装版下载

    易语言5.0测试版1发布于2009/12/28,是易语言5.0静态编译版第一个公开测试版本 ******************************************************************************** ** 以下是易语言4.x及以前版本的升级信息 ...

Global site tag (gtag.js) - Google Analytics