问题标签 [code-documentation]

我有一些 REST 服务（使用和生成应用程序/json）并@TypeHint用于生成文档。

现在我有这样的事情：

但是MyResponse是一个包装List<MyType>。

我的build方法MyResponse看起来像这样：

我想直接使用List<MyType>而不是MyResponse. TypeHint在以下代码中使用哪种方法最好？

我在考虑以下选项：

1. @TypeHint(List.class)
2. @TypeHint(MyType.class)
3. @TypeHint(List<MyType>.class)-> 不幸的是，由于 Java 类型擦除，这不起作用。

问题：

3 号有有效的替代方案吗？

即使类型是 a List，数字1也没有用，因为我自己的类型必须使用注释@XmlRootElement并且是不可List更改的（它来自 JDK）。

数字2有一个解决方法，但它不是很完美：

• 使用数字 2（只是为了在生成的 HTML 文档中有一个可用的示例 - 对该列表中包含的元素的描述）

• 在 Javadoc 中指定它是 a List（例如：在@return单词之后）（可以通过 HTML 标记使用粗体、颜色、斜体等强调）

  例如：

  /li>

细节：

• 发音.version = 1.30.1
• 爪哇 7

我似乎没有找到任何东西，我总是找到的唯一一个就是这个： https ://code.google.com/p/selenium/wiki/WebDriverJs

但它更多的是一个指南。不是所有功能的文档。它缺少例如文档Webdriver.Window或类似的东西getWindowHandles()

我希望能够将模板化的 YARD 文档样式注释插入到我现有的 Rails 遗留应用程序中。目前评论很少。我想要具有指定参数的类头和方法头（通过从我假定的方法签名中提取）和返回值的占位符。

在 PHP 代码中，我有一些工具可以检查代码并在适当的位置创建插入到代码中的文档标题注释。在带有 Duck 类型等的 Ruby 中，我确信 @params 等的类型不能轻易猜出，我对此表示满意 - 我希望在插入后手动逐个查看代码文件。如果可能的话，只想避免将所有骨架模板插入代码（超过 500 个文件）。

我已经搜索了可以执行此操作的宝石等，但到目前为止还没有遇到过。外面有吗？

我有一个大量重载的方法MethodA，在我的文档中的 summary-tag 引用了该方法MethodB：

评论不仅应该依赖于它们的特殊重载，MethodA而且应该依赖于所有这些重载。但是，编译器会打印出 cref 属性不明确的消息（但这是有意的）。是否有解决此问题的最佳实践？我已经考虑see过从summary. 也许您还有其他方法？

我刚刚遇到一个小问题，一直困扰着我：我目前正在创建自己的 R 包，显然需要一些文档/帮助文件。到目前为止我很好，但我目前正在尝试弄清楚如何在 .rd-files 中使用 \choose 命令。它不断在我通过 .rd 文件创建的 PDF 中产生一些奇怪的输出。我目前这样使用它：

这让我

这显然是错误的。如果我省略了选择命令，我会在这里得到我想要的（当然缺少二项式系数）。我尝试了任何我能想到的组合，如 \choose{s,k}、\choose{s}{k}，一切都给了我基本相同的输出。有任何想法吗？

提前致谢！

在 SpriteViewController 中

在 Apple 的 Obj-C 中：

在 Swift 中，由我编写：super.viewDidLoad()

我总是得到“它不起作用！:(”。

有人可以告诉我我做错了什么吗？

如果您想了解有关该项目的更多信息，请参阅此。

谢谢！

我想将帮助/文档文本添加到我用 C# 构建的库中。我正在使用 /// 创建标签，当我在我的图书馆项目中使用我的库的方法时，这工作得很好。例如：

如果我的图书馆有 2 个类 Car 和 Person，如果我输入 Person

VS 的自动完成会建议使用 StartEngine 方法，我会看到该方法的摘要，例如“此方法将启动汽车的引擎”。

但是当我编译并尝试在单独的解决方案中引用 dll 时，问题就出现了。在新的解决方案中，我已经添加了相应的引用和使用语句但是当我写

VS 确实会推荐使用 StartEngine 但我看不到文档。有谁知道为什么？构建库时是否需要添加一些参数？

PD库中所有生成dll的方法都是public的

在为我的 API 文档安装“npm”和“node”之后，我通过以下命令安装了“apidoc”：

在全局安装 apidoc 后，我只是在我的项目目录上运行以下命令（假设 apidoc 将考虑其默认模板文件）：

结果没有错误，也没有生成文档。

同样，我尝试过：

但是什么都没有发生，在那种情况下，我在“mytemplate”目录上什么都没有。

你们能告诉我我错过了安装/考虑什么吗？为什么在命令执行中什么也没有出现？

注意：我将它用于我的 ruby​​ 应用程序，但无法安装它的 gem，因为我们在 ruby​​ 1.9 上运行我们的应用程序并且它需要 ruby​​ 2.0。我需要一个独立的解决方案，它也应该适用于其他项目。

谢谢你。

I want to connect two related define-makros in my doxygen HTML-documentation in such a way, that they are shown in a single description box.

I hope I can describe clearly how it should look like: Normally every define statement gets its own description box using /** @define <description> */. This results in a description box with the code part in the title line of the box and a short description in the box content.

What I want to do now is to connect two define statements in such a way that they are shown in a single box with a common description. Does anybody knows a way to realize that?

PS: Maby it gets a little bit clearer with this ASCII graphic.

+-------------------------+ | #define PORT 1 | | #define PORTDIR 0 | +-------------------------+ | output port definitions | +-------------------------+

我刚刚为 XCode 找到了这个插件，我想知道 XCode 中是否已经实现了这样的功能？

因为在 PHPStorm 中，您只需键入/**+Enter 即可自动创建一个预填充函数所有变量的注释块。