标签: documentation-generation

有没有人使用其他任何东西来记录他们的PHP代码？PHPDoc? 是否有任何工具可以读取相同的文档语法,但提供更丰富的输出？

我已经开发了一个非常优秀的API,我在Postman上有它,它非常好用.现在我必须生成一个html文档,以便将其与我的源代码一起保存在/ docs中.

有没有工具或方法来实现这一目标？我真的不想写所有这些文档.分享邮递员收藏不是一种选择.

我测试了Doxygen和多个GitHub项目(jsdoc,react-docgen,react-doc-generator使用npm i -g如下:

react-doc-generator ./ -o DOCUMENTATION.md
react-docgen --pretty -o out/reactdocgen.html ./
jsdoc ./src
doxywizard

但没有人真正理解最近的ES6 JavaScript和JSX for React Native(甚至没有提到本机代码).我最终得到了无用的文档.

当然,我试图添加注释(和don的\ fn),但是注释完全由手工输入(未生成),有时文档中的代码不存在.

/**
 * 
 * 
 * @class MainScreen
 * @extends {Component}
 */
class MainScreen extends Component {
    /**
     * 
     * \fn navigationOptions()
     * @static
     * @memberof MainScreen
     */

最后我没有找到jsdoc文件夹和子文件夹的方法(但是评论文件的测试结果是subpar).

所以我转向React Native文档大师问:如何为React Native生成文档？

如果仅来自评论,您是否有工具从RN + ES6(+ Native)代码生成注释？

加分点:例如,我们可以自动从导入语句中获取图表吗？喜欢:

似乎有太多的Python文档工具.我碰到的另一个是epydoc.似乎Sphinx是事实上的标准,因为它用于生成官方Python文档.有人可以帮我理清Python文档工具的当前状态吗？

phpDocumentor似乎是记录PHP代码的标准,虽然我不知道为什么它多年没有更新..？

但是,它似乎不适合记录REST API的入口点; IE,系统最终用户可能感兴趣的外部可访问入口点,而不是记录所有内部类等 - 这只是api开发人员感兴趣的内容.

我正在寻找我可以说的东西,嘿这个方法可以通过REST在这个URL外部访问,这里是GET或POST参数,它支持GET/POST/etc HTTP方法,它返回JSON或XML等等.

该信息将能够生成API文档.内部代码也可以使用它来自动过滤输入,验证输出,创建基本单元测试等.

关于记录python源代码的约定和工具有什么用？

我已经安装了Sphinx,以便记录一些我正在研究的python模块和类.虽然标记语言看起来非常好,但我还是没有设法自动记录python代码.

基本上,我有以下python模块:

SegLib.py

还有一个叫它的班级Seg.我想在生成的sphinx文档中显示类和模块的文档字符串,并为其添加更多格式化文本.

我index.rst看起来像这样:

Contents:

.. toctree::
:maxdepth: 2

chapter1.rst

并且chapter1.rst:

This is a header
================
Some text, *italic text*, **bold text**

* bulleted list.  There needs to be a space right after the "*"
* item 2

.. note::
   This is a note.

See :class:`Seg`

但是Seg只是以粗体打印,而不是与类的自动生成的文档相关联.

尝试:参见:class:Seg Module:mod:'SegLib'模块:mod:'SegLib.py'

也没有帮助.任何想法或良好的教程链接？

编辑:将SegLib更改为段(感谢,iElectric!),并将chapter1.rst更改为 ::mod:segmentsModule ------------------------- -

.. automodule:: segments.segments

.. autoclass:: segments.segments.Seg

但是,无法让sphinx直接记录类中的函数,或者更好 - 将类中的所有函数自动添加到文档中.试着

.. autofunction:: segments.segments.Seg.sid …

grails doc在我看来,通过跑步创建的文档并不完全令人满意.例如,控制器中的操作在文档中显示为属性,但我希望有一个额外的部分将操作与实际属性(字符串等)分开.

是否有任何工具可以运行类似JavaDoc的注释并为Grails项目生成更好的输出？它应该是Grails-aware(即理解控制器中的闭包实际上是动作)或允许显式标记(例如@section Actions注释使段落出现在名为"Actions"的部分中)

大家好.我会尝试简单而简单.:)

我有

1. 40个左右的样板文字文件,包含一系列需要填写的字段(名称,地址等).这在历史上是手工完成的,但它是重复和繁琐的.
2. 用户填写了大量有关个人信息的工作簿.

我需要

• 以编程方式(从Excel VBA)打开这些样板文档的方法,编辑工作簿中各种命名区域的字段值,并将填充的模板保存到本地文件夹.

如果我使用VBA以编程方式编辑一组电子表格中的特定值,我会编辑所有这些电子表格以包含一组可在自动填充过程中使用的命名范围,但我不知道任何'命名Word文档中的字段'功能.

我如何编辑文档,并创建一个VBA例程,以便我可以打开每个文档,查找可能需要填写的一组字段,并替换值？

例如,某些东西的作用如下:

for each document in set_of_templates
    if document.FieldExists("Name") then document.Field("Name").value = strName
    if document.FieldExists("Address") then document.Field("Name").value = strAddress
    ...

    document.saveAs( thisWorkbook.Path & "\GeneratedDocs\ " & document.Name )
next document

我考虑过的事情:

• 邮件合并 - 但这是不够的,因为它需要手动打开每个文档并将工作簿结构化为数据源,我有点想要相反.模板是数据源,工作簿正在迭代它们.此外,邮件合并用于使用不同数据的表创建许多相同的文档.我有很多文件都使用相同的数据.
• 使用占位符文本(如"#NAME#")并打开每个文档进行搜索和替换.如果没有提出更优雅的话,我会采用这个解决方案.

我正在尝试使用Google代码样式来记录函数,然后我使用带有拿破仑扩展的sphinx来创建文档.该函数是不寻常的,因为它返回两个参数.我认为拿破仑不会这样做.如果是这样,有人可以告诉我他们是如何处理的吗？

def foo(a):
'''one line summary

longer explanation

Args:
  a (int): parameter description

Returns:
  servers (list): list of servers to use
  msg (str): logging message string 
'''
pass

也许我收到的消息是,返回多个参数并不是很好的编码风格,但是你可以这样做吗？生成的html将这两行视为一个参数的描述的一部分.如果我在服务器和msg行之间添加换行符,它会有所帮助,但它仍然记录了一个arg.