Tag: 文档生成

保留Sphinx中引用的内联代码: 在狮身人面像，如果我有以下标题声明： .. _somestuff: “this is code“, this is not! ============================== 它呈现如下： this is code ，这不是！这是好的，但是，如果我使用的参考，例如： Have a look at :ref:`somestuff` 它丢失了代码格式并呈现如下：看看这是代码，这不是！代替：看看this is code ，这不是！是否可以保留参考中的代码格式？我该怎么办呢？

jQuery兼容的JavaScript文档生成器: 我需要select一个文档生成器（类似于java中的jdoc或Ruby中的rdoc）为我的JavaScript项目（用jQuery，下划线和骨干构build）候选人： jsdoc工具包 PDOC 自然文档 docco YUI文档 doctool http://jquery.bassistance.de/docTool/docTool.html 其他？要求应该使用jQuery，下划线和主干。这意味着对象文字方法等我真的很喜欢pdoc，但是它太过于以原型为中心，没有很好的文档logging，而且我不想制作额外的文件（部分？）来使其工作（不确定这一点） docco是不错的，但我想要结构化的输出（如菜单+ class / func结构像jdoc）必须是命令行/制作文件兼容（不是网上的贴图）提示，技巧，教程，成功的故事，build议非常欢迎。为什么不jQuery使用JSDoc？

有谁知道一个CSS文档工具？: 我们最近使用OOCSS原则重build了我们的网站，这个原则允许一个真正模块化的方式来编写CSS。该网站很大，有许多开发人员在工作，所以我希望能够对CSS进行文档化，以便尽可能有效地重用CSS模块。有没有人有使用自动化CSS文档工具的经验？或者调整另一个文档工具来使用CSS文件？

如何使用roxygenlogging数据集？: 在roxygen进程中，是否可以将.R文件包含在我的软件包的数据目录中？我已经把几个.R文件放在数据目录中。当他们来源于data（）时，他们读取原始数据文件并执行一些转换。

如何使用Pydoc创build文档？: 我试图从我的模块创build一个文档。我使用Python 3.2.3的Windows 7中的命令行使用了pydoc ： python "<path_to_pydoc_>\pydoc.py" -w myModule 这导致我的shell被填充文本，在我的模块中的每个文件一行，说： no Python documentation found for '<file_name>' 就好像Pydoc试图为我的文件获取文档，但我想自动创build它。我找不到使用Google的好教程。有没有人有关于如何使用Pydoc的任何提示？如果我尝试使用一个文件创build文档 python … -w myModule\myFile.py, it says "wrote myFile.html", and when I open it, it has one line of text saying: # ../myModule/myFile.py 此外，它还有一个链接到我的电脑上的文件本身，我可以点击它，并显示在我的网页浏览器中的文件内。

logging从C＃中使用的C ++ / CLI库代码 – 最好的工具和实践？: 我正在从事一个项目，主要从ac＃应用程序中使用c ++ / cli库。有没有什么办法使c ++ / cli中的代码注释可视化到Visual Studio中的c＃intellisence？假设没有，最好的方式来logging的c + + / cli代码，以使其更容易从c＃中使用（当然在c + + / cli当然）？你对XML评论和doxygen vs其他工具（哪些）有什么看法？

自动生成所有Python包内容的文档: 我正在尝试使用Sphinx为我的代码库自动生成基本文档。然而，我很难指示狮身人面像recursion扫描我的文件。我有一个像下面这样的文件夹结构的Python代码库： <workspace> src mypackage __init__.py subpackageA __init__.py submoduleA1 submoduleA2 subpackageB __init__.py submoduleB1 submoduleB2 我在<workspace>运行了sphinx-quickstart，所以现在我的结构如下所示： <workspace> src mypackage __init__.py subpackageA __init__.py submoduleA1 submoduleA2 subpackageB __init__.py submoduleB1 submoduleB2 index.rst _build _static _templates 我已经阅读了快速入门教程http://sphinx.pocoo.org/tutorial.html ，虽然我仍然试图理解文档，但是它的措辞让我担心Sphinx假设我将手动创build我的代码库中的每个模块/类/function的文档文件。但是，我注意到了“automodule”语句，并且在快速启动期间启用了autodoc，所以我希望能够自动生成大部分文档。我修改我的conf.py添加我的src文件夹到sys.path，然后修改我的index.rst使用automodule。所以现在我的index.rst看起来像： Contents: .. toctree:: :maxdepth: 2 Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` .. automodule:: alphabuyer […]

JSDoc：返回对象结构: 我怎么能告诉JSDoc有关返回的对象的结构。我find了@return {{field1: type, field2: type, …}} description语法，并试过了： /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or a jQuery event wrapping such an * event. * @param {string} [type="page"] * A string representing the type of location that should be […]

如何用参数logging一个方法？: 如何使用Python的文档string来logging具有参数的方法？编辑： PEP 257给出了这个例子： def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real — the real part (default 0.0) imag — the imaginary part (default 0.0) """ if imag == 0.0 and real == 0.0: return complex_zero … 这是大多数Python开发人员使用的惯例吗？ Keyword arguments: <parameter name> — Definition (default value if any) 我期待一些更正式的东西，比如 def complex(real=0.0, imag=0.0): """Form […]