个人中心
文章发布
退出
作者热门文章
- iOS/Objective-C 元类和类别
- objective-c - -1001 错误，当 NSURLSession 通过 httpproxy 和/etc/hosts
- java - 使用网络类获取 url 地址
- ios - 推送通知中不播放声音
27
4
我肯定有一个相当普遍的文档需求......
我正在实现一个相当大的 Java 库代码库，除其他外，它包含各种类，这些类旨在在适当的抽象级别上公开给调用者/实现者。同时，代码库当然包含库的用户在使用 API 时不需要了解的各种内部类、接口(interface)和其他抽象。
许多其他 API 库都犯了一个错误，即简单地将所有内容都扔进 Javadocs，并让用户通过猜测组合来确定他们作为调用者实际需要处理哪些对象和实体，推理，如果幸运的话，还有示例代码。
我不想处于同样的位置。我想要一组“内部”Javadocs 来公开代码库的整个范围，以及一组“外部”Javadocs 旨在向开发人员清楚地传达他们实际需要使用的类的特征来获得他们的完工。我不需要也不想用他们不需要看到或知道的各种内部抽象来混淆水域——他们不需要知道这一切在引擎盖下是如何工作的，这只会让他们感到困惑和误导，导致 API 学习过程效率非常低下。
我怎样才能做到这一点？是否存在众所周知的“javadoc”参数组合以及一些可以实现此目的的注释？
非常感谢您的考虑!
最佳答案
假设您已遵循最佳实践并将内部类放在与公共(public) API 不同的包中，您可以运行 javadoc 并将公共(public) API 包名称作为命令行参数。
引用javadoc command line synopsis了解更多详情。
(如果您没有组织您的包以将内部类排除在 API 包之外，您可能会感到有点痛苦......)
关于java - 选择性 API Javadoc，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/2375841/
27
4
0
根据这个: Selectivity is the value between 0 and 1, and it is the fraction of rows returned after applyi
我想知道C是否允许设置选择性#define。这就是我所说的选择性:如果我定义了一个结构: typedef struct mystruct{ int (*pointer_function)(struc
我正在尝试替换 pi与 math.pi使用以下 Python 函数。 def cleanup(x): return x.replace("pi", "math.pi") 我有以下字符串: a =
有没有一种方法可以只对类型声明可用的代码执行流程检查？ 有一种方法可以启用每个文件的检查( header 中的 //@flow)，但是一旦设置，代码的所有部分都需要类型声明(否则会记录错误，如“108
我在 openGL (openGl 1.1 win32) 中绘制了一个场景。 我使用 glClipPlane 隐藏前景对象以允许用户查看/编辑距离部分。选择是在 native 完成的，无需使用 ope
我正在开发允许第三方上传 HTML 片段的服务。在其中一些片段中，可能有指向 CSS 文件或内联 CSS 的链接。该服务有自己的 CSS 文件。 除了 iFrame 之外，还有什么方法可以让我指示特定
假设我有下面列出的用于通过 Web 服务将数据传递给客户端的类(类已简化): public class Customer { public int CustomerId { get; set;
我肯定有一个相当普遍的文档需求...... 我正在实现一个相当大的 Java 库代码库，除其他外，它包含各种类，这些类旨在在适当的抽象级别上公开给调用者/实现者。同时，代码库当然包含库的用户在使用 A
我有我的小 program.jar，它使用了巨大的 library.jar 的一小部分。 是否有一种工具可以将几个 jar 重新打包成一个，以便它可以独立运行并且尽可能小？ 更新:大小很重要。 最佳答
如何为站点的某些部分强制使用 HTTPS，例如登录页面或注册页面，并为站点的其余部分使用 HTTP？ 最佳答案 我最喜欢的强制转换为 https 的方法是将其作为您的 php 脚本中的第一件事。它适用
我一直在慢慢学习 Ruby(在这一点上，这可能是我投入大量时间实际学习的第一门语言)所以这对你们中的许多人来说可能是一个非常简单的问题。 我的学习玩具项目基本上是一个 roguelike。目前，我有一
我正在使用Liip Cache Control bundle处理项目中的缓存。通过使用此捆绑包，您可以像这样配置缓存: liip_cache_control: rules: -
在上个月的某个时候，一个随机网站决定在一个框架中为我公司的网站提供服务。忽略“他们在做什么？”的问题。一分钟，我使用了一些简单的 frame-buster Javascript: if (top.l
假设我有以下 Numpy 数组: array([[3, 5, 0], [7, 0, 2]]) 我现在想在值不为 0 的地方加 2。最快的方法是什么？我必须操纵相当大的多维数组？ 最佳答案 在我看来:
我是 git 的新手，我正尝试在 Github 项目上进行协作。我 fork 了一个项目，添加了功能，并根据自己的需要移植到了 Android。添加的功能需要在基础项目中，而不是 android 相关
在以下两个命令中，第二个抛出异常说“未知编解码器 libfdk_aac”。谁能指出我，可能是什么问题？ $> ffmpeg -loglevel verbose -re -i /var/mp4s/tes
我正在尝试 nvidia 的展开循环指令，但还没有找到有选择地打开它的方法。 假设我有这个... void testUnroll() { #pragma optionNV(unroll all
我们公司最近开始使用git-flow，我们遇到了以下问题: 我们有一个控制应用程序日志级别的 DEV_MODE bool 值，我们希望开发分支始终具有 DEV_MODE=true。 但是，在发布版本时
我试图在我的 DataFrame df 中删除 nan 值，但是我很难在不影响整行的情况下删除每一列。下面是我的 df 示例。 Advertising No Advertising nan
我已将播放服务更新到最新版本，目前为 9.2.0，我还想为谷歌播放服务使用选择性模块。 // compile 'com.google.android.gms:play-services:9.2.
我是一名优秀的程序员,十分优秀！