documentation-generation 相关问题

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

Doxygen javadoc样式标记描述跨越多行

在C ++项目中，我使用doxygen和javadoc样式进行文档编制。我是javadoc的新手，我不确定这种类型的东西是否有效。 / ** * ......东西...... * @return foo foo foo ...

documentation javadoc doxygen documentation-generation

回答 1 投票 5

如何将Markdown文件指定为Doxygen中的另一个选项卡？

考虑具有以下两个文件的项目。请注意，OtherTab.md位于子目录中。 README.md＃这是主页面。主页内容。 wiki / OtherTab.md＃这是另一个标签...

documentation markdown doxygen documentation-generation

回答 1 投票 1

Doxygen解析javadoc？

我很好奇Doxygen是否解析了Javadoc的评论？ - 也就是说，doxygen接受类似的东西：/ **用“Hello”消息打招呼。 @param包含人名或...的字符串

documentation javadoc doxygen documentation-generation

回答 1 投票 3

Swift文档评论@code等价。

我知道Swift文档注释及其许多用于记录代码的标记，例如：param：，：return：等。但是我无法找到或弄清楚@code Objective-C文档......

ios swift documentation-generation

回答 2 投票 2

为什么Doxygen对移动设备如此不友好？

Doxygen似乎是C ++（以及许多其他语言）中代码文档的首选，但每次我从手机浏览Doxygen生成的文档时，该网站都不会滚动，文本...

mobile doxygen documentation-generation

回答 1 投票 7

文档框架，如ObjectiveD的JavaDoc

Objective C是否有类似于JavaDoc的文档框架，可以从源代码生成文档？

objective-c documentation-generation

回答 5 投票 20

Swift是否有文档生成支持？降价

许多语言都支持文档注释，允许生成器（如javadoc或doxygen）通过解析相同的代码来生成代码文档。 Swift有没有任何类型的文档评论......

swift documentation-generation

回答 11 投票 224

自动生成PHP文档？ [关闭]

对于ActionScript 2，我使用过NaturalDocs。但是它对PHP的支持很差。到目前为止我看过doxygen和phpDocumentor，但是我认为它们的输出非常难看。有没有人......

php documentation documentation-generation

回答 9 投票 36

Swift文档评论

我有一些关于Swift文档注释的问题。反正有没有像一些Apple文档那样制作一个相关的声明部分。例如，当我选择+单击...

ios xcode swift xcode6 documentation-generation

回答 5 投票 21

如何使用参数记录方法？

如何使用Python的文档字符串记录带参数的方法？编辑：PEP 257给出了这个例子：def complex（real = 0.0，imag = 0.0）：“”“形成一个复数。关键字参数：...

python documentation documentation-generation

回答 7 投票 112

VS2010：自动生成的XML文档文件未更新

我在vs2010中有一个C＃项目，它生成一个XML文档文件，我在其中将生成的文件的输出路径设置为项目输出路径。我的问题是该文件没有更新...

c# visual-studio-2010 documentation documentation-generation

回答 2 投票 8

如何将Sphinx和Pycco用于Python文档？

我希望能够将Sphinx用于主项目文档，因此文档字符串必须在reStructuredText中，但我也想生成HTML以便以...的方式阅读内联注释。

python python-sphinx documentation-generation

回答 2 投票 1

无法在https://editor.swagger.io/生成客户端typescript-fetch

嘿伙计我有问题从https://editor.swagger.io/生成客户端typescript-fetch当我尝试生成typescript客户端时，没有任何反应，它在控制台>控制台上显示...

javascript typescript documentation-generation swagger-editor

回答 1 投票 -1

如何使用DocFx为解决方案中的其他项目生成文档

我正在使用DocFx在Visual Studio 2015中自动生成文档。根据“入门”说明，我添加了一个空的ASP.NET 4 Web应用程序并使用Nuget控制台来...

documentation-generation docfx

回答 2 投票 9

Doxygen默认评论

是否可以在Doxygen中定义类似宏的东西？我想写一个这样的注释：/ ** \ return return_self_reference * /和Doxygen将用一个替换return_self_reference ...

documentation doxygen documentation-generation code-documentation

回答 1 投票 1

可以直接从代码生成类图的程序

我有一个很大的C＃项目，我开始失去概述。我想知道是否有一些软件可以用图形方式表示我的课程，它会调用什么，等等...

c# import uml documentation-generation class-diagram

回答 2 投票 6

Python-Sphinx中Toctree的多个级别

我正在尝试使用sphinx来记录文档的多个“级别”，例如：Api参考手册教程等。这个想法是侧栏上显示的内容相对于......

python documentation python-sphinx documentation-generation read-the-docs

回答 2 投票 7

命名doxygen @ref

我如何命名Doxygen @ref标签？我已经尝试了以下内容：请参阅@ref hello_world hello获取更多信息哪个输出：请参阅hello_world hello获取更多信息其中......

syntax documentation doxygen documentation-generation

回答 1 投票 1

你如何编写包文档？ [关闭]

我还没有找到一个合理的工作流程来构建包和编写他们的文档。我希望尽可能多地自动生成流程（和文档）。 ...

r documentation packages documentation-generation roxygen2

回答 2 投票 25

为REST API生成DOC [关闭]

我已经生成了我的REST API，现在我必须编写API的文档。由于API主要由第三方插件生成，因此无法自动生成DOC。所以呢 ...

php api documentation documentation-generation

回答 2 投票 0

documentation-generation 相关问题

最新问题