问题标签 [code-documentation]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
coldfusion - ColdFusion，并为多个开发团队记录代码和工具
我正在使用 ColdFusion 开始一个相当大的新项目。这个新项目将包括几个开发人员，因此代码文档将是关键。
我希望避免的另一个问题（使用足够的代码文档或其他工具）是代码重复。能够“索引”用于搜索或图表的代码的工具可能会在这里有所帮助。
还有什么其他人专门用于 ColdFusion 或与语言无关的。如果这有所作为，我们可能会将 ColdBox 用于底层框架。
感谢您提出任何建议。
-C
php - PHPdoc - 为 stdClass 的对象定义对象属性
我试图弄清楚是否可以使用 PHPdoc 来定义函数或对象方法返回的对象属性。
假设我有以下课程：
现在，很容易定义输入参数。
问题是定义相关方法返回的输出对象（stdClass）的属性是否有类似的东西。这样另一个程序员就不必打开这个类并手动查看方法来查看返回对象返回了什么？
documentation - phpDocumentor - 如何记录不同的作者更新代码和日期？
假设一个类的原始文档如下所示：
如果我来修改 50% 的代码，我如何证明我做出了重大贡献？
添加日期的最佳方法是什么？例如，上次修改代码的时间、我进行更新的时间或版本的更新时间。
documentation - 内部源代码文档 - FiM++
FiM++ 程序的结构要求它以特定方式以字母结尾和代码作者姓名结尾。
根据语言规范，关键字“你忠实的学生”（包括逗号但不包括后面的空格）用作类定义的结束标记，后面的名称是没有句法效果的注释。
作者自动包含在每个文件中（如果不是严格要求的话）的事实让我想知道它是否可以用作类似于 Java Docs 的可解释文档的形式。换句话说，其他程序或编辑器将能够解析出这个名称并以某种方式使用它。
这种基于评论的内部文档的要求是什么？这种特定类型的语法中是否有任何会导致问题的东西？
关键字是否足以适合主题？我突然想到，如果无法使用“您忠实的学生”作为复数形式（或者可能是“您忠实的”或“您的真实”作为模棱两可的版本），列出多个作者会显得尴尬和不自然（并且看起来像一个自然的人类书写的字母是核心设计范式之一）。
如果考虑创建 Java Docs 方法，那么应该包括哪些其他功能？一方面，约会似乎很常见。在信的顶部包含某种形式的日期注释可能看起来很自然，并且不会违反设计范式。
由于该语言是新的，对大多数人来说不熟悉，而且老实说非常愚蠢，所以这里有一些资源需要考虑：
google-apps-script - Google Apps 脚本自动生成的库文档
我目前正在为 Google Apps 脚本开发一个库，它基本上将电子表格视为数据库对象。
目前，该库有两个相同的功能，如
现在，对于这两个公共函数，生成的文档只显示返回类型，而不是参数或附加说明。我假设这是一个谷歌问题，并没有真正打扰。
但我的主要问题是，由于函数正在从私有函数实例化一个对象，我怎样才能获得自动文档以显示该对象上存在的方法。所有功能都将由对象提供，如果 GAS 可以在其上显示方法，那就太好了。
笔记
方法都放在函数的原型上。例如。
谢谢。
ios - 使用 Appledocs 生成文档
我为我的问题的简单性道歉，但我试图使用 Appledocs 生成文档（https://github.com/tomaz/appledoc#quick-install）
我不确定如何设置它。我这样做的方式是：
- 我克隆了 github 存储库，然后在终端中使用安装脚本（我使用 appledocs --help 确认这一点）安装了 appledocs 。
但是，现在我如何实际使用它，因为我在 xcode 中有我的项目：
- 如何生成文档文件
- 它是在哪里生成的？
python - Python 解释器模式 - 有哪些方法可以探索 Python 的模块及其用法
在 Python 解释器中：
有哪些方法可以了解我拥有的包裹？
SyntaxError：无效的语法
更正：
现在，我如何查看我的 sys.path 上所有可用的包？并查看它们的后续用法和文档。我知道我可以轻松下载 PDF，但所有这些东西都已经准备好了，我不想复制文件。
谢谢！
python - Python 标头——$（美元符号）封装的目的是什么？
提前道歉，这是我真的认为我可以在网上找到的东西，但我遇到了麻烦。
在 Python 中，在标题部分，我看到有时人们会用美元符号 ( $ ) 包装他们的文字。从示例来看，似乎这是一个用于填写自动更新信息的指针（可能是通过源代码管理？），但我不明白它是如何工作的。
例如：
是我在（ Python 示例文档模板 ）中找到的一个示例。所以 $ 包裹在版本（会随着时间而改变）和日期（也会改变）周围。假设它是某种指针，可以始终捕获有关版本、日期等的最新信息，有人可以指出它是如何工作的吗？哪个源代码控制软件使用这种语法？跨语言是一样的吗？
谢谢！
python - 三个箭头 (">>>") 标志是什么意思？
>>>尽管我经常在源代码中看到它，但我无法弄清楚它的作用。
hyperlink - 通过“超链接”获取文档的源代码
我越来越坚持记录我的所有代码并向我的团队中的用户和其他工程师展示我在哪里找到给定的信息，或者我在哪里找到了特定的代码部分。
我希望能够完成的是创建指向我的代码行或文件（Verilog/SystemVerilog、VHDL、C/C++ 和 RTL 源）的链接，但真正找到或想出一个解决方案来用任何语言这样做会对我有益。
这将通过 Word 文档、PDF 文件完成，我不介意设置、使用 LaTeX 等，但我想找到一种方法。本质上，我想单击一个参考，在其中我指定了行或文件，并且该文件在编辑器中显示给读者。
所有文档都将放置在所有使用该文件的用户都可以看到必要文件的地方，我的偏好是能够在 Linux 中执行此操作。