Questions tagged «documentation-generation»

许多语言都支持文档注释，以允许生成器（如javadoc或doxygen）通过解析相同的代码来生成代码文档。 Swift是否有像这样的任何类型文档注释功能？

238 swift  documentation-generation 

如何将返回的对象的结构告诉JSDoc。我找到了@return {{field1: type, field2: type, ...}} description语法并尝试了它： /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or a jQuery event wrapping such an * event. * @param {string} [type="page"] * A string representing the type of …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

如何使用Python的文档字符串来记录带有参数的方法？ 编辑： PEP 257给出了这个例子： def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0) """ if imag == 0.0 and real == 0.0: return complex_zero ... 这是大多数Python开发人员使用的约定吗？ Keyword arguments: <parameter name> -- Definition (default value if any) …

139 python  documentation  documentation-generation 

我正在尝试从我的模块中创建一个文档。我pydoc在Windows 7中使用Python 3.2.3从命令行使用： python "<path_to_pydoc_>\pydoc.py" -w myModule 这导致我的shell充满文本，模块中每个文件一行一行，说： no Python documentation found for '<file_name>' 就像Pydoc试图获取我的文件的文档一样，但是我想自动创建它。我找不到使用Google的优秀教程。有人对使用Pydoc有任何提示吗？ 如果我尝试使用以下方法从一个文件创建文档 python ... -w myModule\myFile.py 它说wrote myFile.html，当我打开它时，它有一行文字说： # ../myModule/myFile.py 另外，它具有指向我计算机上文件本身的链接，单击该链接即可显示Web浏览器中文件的内容。

76 python  documentation  python-3.x  documentation-generation  pydoc 

我需要为我的工作场所实施一个文档生成解决方案，并将其范围缩小到标题中提到的三个。通过对这些解决方案进行形式化比较的方式，我已经能够找到很少的信息，并且我希望那些具有上述一种或多种经验的人能够参与其中： 这是我从最初的通行证中学到的东西： HeaderDoc优点：与Apple的现有文档一致，与制作Apple文档集兼容 。HeaderDoc缺点：难以修改行为，项目未积极开展工作，许多人已经放弃了它（这意味着必须存在某些缺陷，尽管我无法对其进行量化） ）。 Doxygen优点：具有广泛使用基础，非常可定制的大多数输出​​类型（如乳胶等）的主动支持社区b / c Doxygen缺点：需要努力使其外观与Apple Docs一致，与Apple docsets的兼容性并不是那么简单 AppleDoc优点：外观与Apple现有文档一致，与制作Apple文档集兼容， AppleDoc缺点：积极开发typedef，枚举和函数文档的问题 这听起来准确吗？我们所需的解决方案将具有： 与Apple Objective-C类参考一致的外观 单击选项的功能可以从Xcode中提取文档参考，然后链接到文档（就像Apple的类一样） 智能处理类别，扩展名等（甚至包括苹果类的自定义类别） 能够创建我们自己的参考页（例如此页：正在加载...，其中可以包含图像，并且可以与生成的类引用进行无缝链接，例如Apple的UIViewController类引用如何链接到链接的页面。 易于运行的命令行命令，可以集成到构建脚本中 优雅地处理非常大的代码库 根据以上所有信息，上述任何解决方案是否明显优于其他解决方案？任何建议或补充信息将不胜感激。

74 doxygen  documentation-generation  headerdoc  appledoc