问题标签 [code-documentation]

是否有任何专门的标准或工具来记录 AngularJS 指令？我们正在明确构建可重用功能的片段，因此我们应该能够将它们的接口传递给开发人员。我看到了几件事：

• 昂首阔步。我喜欢 Swagger 2.0 的发展方向，但不清楚它将如何用于记录指令。
• Ngdoc ( https://github.com/angular/angular.js/wiki/Writing-AngularJS-Documentation ) 它的优点是它与 AngularJS 团队使用的工具相同。

人们是否找到了更好的方法？

我使用 X-Code 已经 2 个月了。我有我的低点和高点，因为我确实需要从其他 IDE 中搜索我习惯使用的某些功能。

现在我确实有一个关于记录代码的问题。

从在 Eclipse 中开发 Java 开始，我习惯于使用 (/** + Enter) 自动生成方法的文档注释，这在 X-Code 中不起作用。有没有类似的方法，还是我必须自己写整个评论块？

感谢您的快速输入。

干杯

基本上，我们希望在 CD 上以 JAR 的形式发布 API。除了 JAR，我希望我们可以拥有 javadoc，加上一个自述文件，也许还有一些示例都集成在一个漂亮的小网站中。而且我希望示例和自述文件在每次重新生成 javadoc 时都不会被破坏或取消链接。

我觉得必须有现成的东西，但我一定没有正确搜索。有这方面的工具或最佳实践吗？

谢谢！

我找不到任何便宜的工具来记录 PHP 脚本中的所有 vars/consts/functs/classes/includes，所以我正在编写自己的。（我使用了很多需要修改的开源脚本。另外，我自己的项目有一个目录会很好。）

我已经使用 php 字符串函数将一个组合在一起，找到所有常量，然后遍历脚本的每一行，将行号加载到数组中，然后是包含/要求，然后是变量等。这得到了大约 90%我想要的是。但是，如果我要改进它，我可能会改变处理脚本字符的方法，就像 php 编译器可能所做的那样。任何人都有更好的想法如何解决这个问题？我不敢相信我必须发明这个轮子......

我想有些编程环境内置了这个功能，但我是老派，预算很低。而且，是的，OO 和紧凑的函数消除了记录大多数 var 的需要，但仍然需要查看 include/require 树、记录全局变量、查看类的所有实例的使用位置以及如何使用等等。

您好，我想开始在 Apple 的 Swift 语言上运行一些微基准测试。但是，我觉得很难找到有关编译器优化的不同选项的适当文档。

我已经阅读了很多关于其他人的语言微基准的问题和文章，但是如果有一些关于这个主题的可靠文档会很好。

在最新的测试版中，使用的似乎是：

-Onone 没有优化

-O 安全优化？

-Ounchecked（替换 -Ofast）不安全的优化，（不检查整数溢出、数组越界等）

我的问题是，这些都是我可能的选择吗？有没有人有一些资源来记录这一点？

编辑： 我在这里找到了与我需要的关于带有 gcc 的 Objective-c 的类似文档： https ://gcc.gnu.org/onlinedocs/gcc-2.95.3/gcc_2.html第 2.8 节。这就是我需要的 Swift ..

我一直在尝试使用 JSDoc 记录以下代码：

但是greet在生成的 JSDoc 文档中找不到该方法。我究竟做错了什么？

当我使用此命令通过 USB 将设备连接到 Android 调试桥 (ADB) 时：

然后我得到以下（加密的）16个字符：

这些字符是什么？它们是由 Windows 还是 ADB 生成的？这些字符是否临时存储或显示在其他任何地方？

我如何告诉 JSDoc 返回的对象的结构。我找到了@return {{field1: type, field2: type, ...}} description语法并尝试了它：

虽然解析成功，但生成的文档只是说明：

我正在开发一个 API，需要人们了解他们将返回的对象。这在 JSDoc 中可能吗？我正在使用 JSDoc3.3.0-beta1。

有没有办法做到这一点？

我已经为我的其他 API 生成内容，但我不相信它适用于 SignalR。

     我希望能够使用一种工具，让您在源代码的上下文中可视化程序的控制流。澄清一下，这样的工具基本上应该通过以多向图的形式吐出人类可读的抽象语法树来显示程序中发生的事情，其中​​节点包含源代码翻译单元的片段。我认为，生成的图形初始节点将包含以程序入口点开头的代码块（main用于 C 或 C++ 程序。）当节点需要引用另一个代码块时，将创建新节点，无论是在当前文件中还是在另一个文件中，箭头都会连接节点。这样的工具是否存在，还是必须从头开始创建？