相关疑难解决方法(0)

用自上而下的方法用Java设计API - 写Javadoc是最好的起点吗?

每当我需要用Java设计API时,我通常会先打开我的IDE,然后创建包,类和接口.方法实现都是虚拟的,但javadocs是详细的.

这是最好的办法吗?我开始觉得API文档应该是第一个被淘汰的 - 甚至在第一个.java文件被写入之前.这没什么好处:

  1. API设计人员可以完成设计和规范,然后在多个实现者之间拆分实现.
  2. 更灵活 - 设计更改不需要在java文件中反弹,寻找编辑javadoc注释的位置.

还有其他人分享这个意见吗?如果是这样,您如何开始使用API​​设计?

此外,有什么工具可以帮助吗?甚至可能是某种基于注释的工具,它可以生成文档,然后生成骨架源(类似于模型到代码生成器)?我遇到了Eclipse PDE API工具 - 但这是Eclipse插件项目特有的.我没有找到更通用的东西.

java javadoc api-design topdown

8
推荐指数
1
解决办法
1215
查看次数

标签 统计

api-design ×1

java ×1

javadoc ×1

topdown ×1