Julia 朱莉娅'；s相当于R'；s帮助页面和小插曲？

来自R的背景，刚刚开始学习Julia，我想知道Julia中的文档如何，是否有类似于R的帮助页面和小插曲

---

此外，在R中，可以使用roxygen注释块来记录函数，Julia中是否也有类似的内容？

我认为最好通过示例来理解事情是如何工作的。我将评论DataFrames.jl是如何记录的，因为这是一种非常标准的方法：

函数是使用docstring记录的，是函数名的docstring示例；然后通过帮助系统（按？）以交互方式发现这些文档字符串

为包生成文档的标准方法是使用；顺便说一句：这个软件包有一个伟大的维护团队，他们非常乐于助人，反应迅速；您有一个指向make.jl文件的链接，该文件用于生成文档；请特别注意选项

doctest=true

，该选项确保按照Documenter.jl规则正确编写的所有代码示例都会产生预期的输出

为了设置包文档的自动生成，您需要在GitHub上设置CI集成；再说一遍，有很多方法可以做到这一点；一个标准的方法是使用GitHub操作；您有一个指向ci.yml规范文件部分的链接，该文件确保文档是作为ci的一部分构建的；然后，在任何PR中，例如（我提供了一个指向当前打开的PR的链接，该PR与文档相关），您可以在报告CI结果一节中看到，在运行测试后，还生成了文档。您可以看到使用此工具链生成的文档的外观（例如，请注意，在底部，您可以动态切换要阅读手册的软件包的版本，这表明这里的所有内容都集成得很好，而不仅仅是一堆PDF或HTML文件）

我希望这将帮助你开始。我已经向您指出了GitHub上托管的包通常使用的所有基本部分（即，这不是唯一的方法，但却是最常用的标准方法）

---

要掌握以上所有细节，您需要仔细阅读Julia手册和Documenter.jl中的文档。不幸的是，编写适当的文档并不容易（在任何编程语言中）。好的是Julia有一个非常优秀的工具链，可以很好地支持这个过程。

我认为最好通过例子来理解事情是如何运作的。我将评论DataFrames.jl是如何记录的，因为这是一种非常标准的方法：

函数是使用docstring记录的，是函数名的docstring示例；然后通过帮助系统（按？）以交互方式发现这些文档字符串

为包生成文档的标准方法是使用；顺便说一句：这个软件包有一个伟大的维护团队，他们非常乐于助人，反应迅速；您有一个指向make.jl文件的链接，该文件用于生成文档；请特别注意选项

doctest=true

，该选项确保按照Documenter.jl规则正确编写的所有代码示例都会产生预期的输出

为了设置包文档的自动生成，您需要在GitHub上设置CI集成；再说一遍，有很多方法可以做到这一点；一个标准的方法是使用GitHub操作；您有一个指向ci.yml规范文件部分的链接，该文件确保文档是作为ci的一部分构建的；然后，在任何PR中，例如（我提供了一个指向当前打开的PR的链接，该PR与文档相关），您可以在报告CI结果一节中看到，在运行测试后，还生成了文档。您可以看到使用此工具链生成的文档的外观（例如，请注意，在底部，您可以动态切换要阅读手册的软件包的版本，这表明这里的所有内容都集成得很好，而不仅仅是一堆PDF或HTML文件）

我希望这将帮助你开始。我已经向您指出了GitHub上托管的包通常使用的所有基本部分（即，这不是唯一的方法，但却是最常用的标准方法）

---

要掌握以上所有细节，您需要仔细阅读Julia手册和Documenter.jl中的文档。不幸的是，编写适当的文档并不容易（在任何编程语言中）。好的是Julia有一个非常优秀的工具链，可以很好地支持这一过程。

如果要编写文档，请检查上面的链接有pdf格式，它是否回答了您的问题这里的R标记不充分如果要编写文档，请检查上面的链接有pdf格式，它是否回答了您的问题这里的问题标签不足以让你通过一个真实的案例来提供答案。事实上，我所缺少的，比本文中所解释的更多的是，在朱莉娅软件包开发的宏伟计划中，每一块都适合于哪里。您在哪里提供长格式文档，是DataFrames.jl/docs/src/man/？Yes中的那些标记文件。此处定义了页面的结构：。但是请注意，如果软件包开发人员需要，源代码中的docstring也可以自动添加为文档的一部分-您在docs/src/lib/functions.md中有一个如何执行此操作的示例。本答案中介绍了该过程的分步指南：这是一篇非常好的文章。感谢您维护它（因为我知道维护与集成相关的东西是一项艰巨的工作）。非常感谢您通过一个真实的案例提供了答案。事实上，我所缺少的，比本文中所解释的更多的是，在朱莉娅软件包开发的宏伟计划中，每一块都适合于哪里。你们在哪里提供长格式文档，是那些降价文件吗