(44):为所有导出的API元素编写文档注释
来源:互联网 发布:数据挖掘应用角度 编辑:程序博客网 时间:2024/06/06 03:25
要想使一个API真正可用,就必须为其编写文档。Java提供了Javadoc工具,使得为API编写文档变得非常容易。Javadoc利用特殊格式的文档注释,根据源代码自动生成API文档。
示例:
/** * Returns the element at the specified position in this list. * * <p>This method is <i>not</i> guaranteed to run in constant * time. In some implementations it may run in time proportional * to the element position. * * @param index index of element to return; must be * non-negative and less than the size of this list * @return the element at the specified position in this list * @throws IndexOutOfBoundsException if the index is out of range * ({@code index < 0 || index >= this.size()}) */E get(int index);
0 0
- (44):为所有导出的API元素编写文档注释
- 第44条 为所有导出的API元素编写文档注释
- 为所有到处的API做文档注释(大牛们做JAR包的时候需要做好的事情哦)
- Myeclipse文档注释如何提炼(导出)成自己的API帮助文档?
- 单行注释、多行注释、文档注释最完美的解释、导出API
- 如何为我们的程序编写开发文档——Java文档注释
- 修改Xcode自动生成的文件注释来导出API文档
- 修改Xcode自动生成的文件注释来导出API文档
- 修改Xcode自动生成的文件注释来导出API文档
- 修改Xcode自动生成的文件注释来导出API文档
- Ruby编写的取得Pyton所有函数并导出到XML文档的程序
- 编写程序,使用指针把一个int型数组的所有元素设置为0
- Javadoc编写文档注释
- 文档注释导出帮助文档
- 如何优雅的“编写”api接口文档(续)
- 为javadoc文档的包生成注释
- 如何导出java的api文档
- 使用Javadoc导出项目的API文档
- Spark2.1.0安装和配置
- spring mvc使用@InitBinder 标签对表单数据绑定
- 基于R语言构建的电影评分预测模型
- 安卓5.1源码解析 : RecyclerView解析 从绘制流程,ViewHolder复用机制,LayoutManger,ItemAnimator等流程全面讲解
- numpy中的ndarray方法和属性
- (44):为所有导出的API元素编写文档注释
- JS获取DOM的高度包括Padding margin border
- java折线分割平面
- 自定义view-圆环
- River Hopscotch POJ
- 使用vs自带的git工具时出现*.opendb被占用而无法同步的问题
- Quartz配置上次任务没有执行完,下次任务推迟执行,
- js input 限制输入的各种方法
- 科锐课堂笔记:2017/4/20 抽象类