documentation-generation 相关问题

文档生成器是一种编程工具,它从一组特别注释的源代码文件(在某些情况下是二进制文件)中为程序员(API文档)或最终用户(最终用户指南)或两者生成文档。

为所有Class方法打印python文档字符串

我想打印一个模块的文档,以包含每个类和该类中每个方法的文档字符串,但只包括我编写的方法;不是默认方法。这是...

回答 1 投票 2

如何包括和排除目录与documentationjs解析

特别是,我感兴趣的是排除任何node_modules文件夹,但也有其他需要被排除在外。这通常是完成在配置文件;例如,一个.jsdoc文件,像这样:” ...

回答 1 投票 1

Sphinx:突出显示支持的语言列表?

我正在使用Sphinx代码文档并在代码中使用多种语言,我想为所有代码设置突出显示。 Sphinx简要提到了它支持的一些语言(...

回答 3 投票 10

自动更新Doxygen文档并使用户可以随时使用CMake

我已经研究了多个使用CMake构建的C ++库并运行Doxygen来生成HTML文档。在这些库中的每一个中,文档都被内置到“html”文件夹中......

回答 2 投票 0

为Haskell开发人员自动生成Servant-API文档

我使用越来越大的servant构建了一个web-API。我知道有两种方法可以自动为api创建文档。首先,有蠢货。 Haddock把我的代码变成......

回答 1 投票 1

Django restframework记录视图

我的问题是:我如何填写字段说明?在我的文档页面中的参数表中,这里是我的函数示例和截图如何看起来def删除(self,request,id_):...

回答 1 投票 4

在Enterprise Architect中为REST API创建规范

我的客户希望我使用Enterprise Architect(SparxSystems)为未来的REST API创建规范。可交付成果应该是格式良好的文本(可以是html,docx或rtf)。一类 ...

回答 3 投票 9

Antora顶级导航栏定制

我的问题很简单,但我在文档中找不到任何指向它的内容。我正在使用Antora中的默认生成器为项目生成文档,但我无法想象......

回答 2 投票 1

将phpdoc转换为Dash可用的docset

我试图以一种我可以在Dash中使用的格式获取Magento文档。 Dash网站上的一篇文章介绍了如何将多种类型的文档导入所需的格式,...

回答 1 投票 5

ExDoc:获取源链接 与私有存储库一起使用

我正在尝试为我的项目生成文档。我已将{:ex_doc,“〜> 0.16”,仅::: dev,runtime:false}添加到我的deps中,将source_url设置为我的存储库并运行mix docs。我正在使用Github ......

回答 1 投票 0

Docfx不构建和输出其他路径

有两个责任;在第一个问题之前我的项目层次结构这个和我想要每个项目代码到这个文档我使用docfx。第一个问题;我不想要建筑......

回答 1 投票 0

文档java代码

有没有免费体面的程序来为java做代码文档?很难完成编码项目,然后需要花时间编写文档。如果你知道,请告诉我....

回答 6 投票 1

XMLDoc Delphi源代码文档生成

我假设XML和Delphi文档指南正在成为源代码记录注释的事实标准。那很好。坏事是我找不到任何Delphi ......

回答 2 投票 7

文档生成 - 我应该打算选择哪些方框?

我正在考虑要求我的团队更彻底地记录他们的代码,以便进行一些重大的即将到来的项目,并让生活变得更加痛苦,我正在转向XML文档生成器......

回答 2 投票 4

Doxygen乳胶误解了预处理器的定义

好的,让我再次尝试使用SO而不是Tex。所以我正在尝试使用Doxygen创建一些PDF。我在我的Windows 7盒子上安装了MiKTeX,并设法获得所需的所有样式......

回答 1 投票 0

如何使用sphinx-apidoc记录Python函数参数

我正在尝试清理我的python代码文档,并决定使用sphinx-doc,因为它看起来不错。我喜欢如何使用以下标签引用其他类和方法:class:`mymodule ....

回答 2 投票 16

使用MS Word和C#xmldoc支持的帮助生成工具[关闭]

我正在寻找一个满足这些要求的帮助/文档生成工具:它应该支持c#编译器生成的xmldoc注释,或者(甚至更好)直接支持sandcastle ...

回答 6 投票 11

使用Doxygen使用@see命令引用特定的类方法

我无法使用doxygen @see命令引用特定的类方法。假设我有一个类Server,其方法如下所示@interface Server:NSObject - (void)start:(...

回答 2 投票 6

有什么比PHPDoc更好的吗? [关闭]

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

回答 9 投票 22

如何使Doxygen在包含XML片段的@code中进行语法高亮显示?

我正在记录一个操纵XML数据格式的软件库。我希望能够在文档中编写XML示例,自然的方法是@code {.xml} ... xml ...

回答 1 投票 1

© www.soinside.com 2019 - 2024. All rights reserved.