documentation-generation

    1热度

    1回答

    如何将狮身人面像生成的乳胶代码集成到现有的乳胶文档中? 我的问题与here相同,但我在6年后认为应该找到解决此问题的方法。如果没有,现在有一些步骤可以手动进行?最佳实践?

    0热度

    1回答

    有两个责任; 第一个问题 我的项目层次this 和我之前想对每一个项目的代码文档为了这个,我使用docfx。第一个问题是 ; 我不希望构建代码被重建。 ex。 docfx ./docs/docfx.json --serve -> doing the build 第二个问题; 我想要文档结果给我其他路径。 ex。 C:\Users\ahmet\Documentation 代码 docfx d

    -1热度

    1回答

    我正在使用Specflow来编写我的Web自动化测试,并且一切进展顺利。 我正在使用配置文件中的目标为每个浏览器运行一次我的功能。 我想使用Pickles来记录我的功能和测试结果,但它结合了结果并采取了最好的措施。 例如,我有一个测试在Firefox中失败,但通过Chrome和IE。 当我创建我的Pickles文档时,它将标记为已通过的一个测试。 有没有人知道如何/如果酱菜可以支持多次运行的功能或

    1热度

    1回答

    我使用组织模式编写软件文档,其中API函数,变量等文档自动从其中提取代码的文档字符串(恰好在Common Lisp中)。然后将该文档导出为HTML(我碰巧通过reStructuredText通过ox-rst和Sphinx执行此操作)。它的工作原理很像使用Sphinx直接与Python一起使用,但具有组织模式的所有特性,如可执行代码块。 为了简要说明原理,我演示了使用Emacs Lisp进行简化的方

    -2热度

    1回答

    为某些通信或配置文件创建XML时,您可能需要向其他人说明该文件的工作原理。什么标签用于什么。 首先,您将创建XSD,您将在其中定义如何创建和使用XML。还有annotation和documentation标签可以更好地解释它。 但是,有没有工具如何将XSD转换为对普通用户更易读的文档?例如在设置od html文件或tex或pdf文件中。 如果它有关系图像,那会更好,但这不是必须的。

    -1热度

    1回答

    scikit-learn是一个组织良好的网站,是一种整洁的文档源代码方式。网页是否自动生成?有没有一个框架产生这些网页? 学习使用了哪个框架可以帮助我记录其他类似的存储库。

    1热度

    1回答

    我们在这里得到了一些像10年前的C和C++代码,没有文档或手册。然而,头文件中记录的源代码相当不错,但通过所有查找信息的文件需要很多工作。它看起来像这样: // Description description .... // // @param parameter 1 name: // description of parameter 1 // // @param parameter 2

    0热度

    1回答

    在用roxygen2记录S4类之后,我决定退后一步,使用package.skeleton,promptClass和promptMethod创建最小示例。 我的问题是R CMD check仍然给出了一个关于“无证代码对象”的警告,但我认为我已经正确记录它们。 我现在的文件有: testClass.R: setClass("testClass", slots = c(a = "numeri

    2热度

    1回答

    我想创建一个打字稿DOC发电机JSON模式,但这样做,我需要解析打字稿文件到的东西更容易阅读 EX: "Command": { "description": "A command object for the command handler", "constructor": [ { "name": "name", "type": "strin

    0热度

    1回答

    运行沿侧styleguidist我想记录我的反应的组分和我一起端运行styleguidist服务器与Laravel开发服务器但styleguidist服务器崩溃,此错误。 You have another server running at port 6060 somewhere, shut it down first You can change the port using the `se