列出emacs中的所有顶级全局变量
主要是为了我自己的修改，我试图列出当前Emacs会话中加载的所有全局变量。我正在想的是生成一个包含所有列出的功能的HTML文件。当然，还有一些有用的功能是定义函数var的文件。 有没有什么已经内置到emacs中？ L - 解决方案 这些行应该做些什么： （let（（result'（））） （mapatoms（lambda（x） （when（boundp x） （文件（忽
..
documentation-generation相关内容
哪个文件系统使用这种格式？
#pragma region INFO / * * @ FUNCTION：GetSubStrBetween * * @ PARAMETER（s）： * [1st] std :: string& in_Str =此参数使用std :: string，其中 *是包含未知子字符串的字符串。 * * [2nd] std :: string in_A =此参数接收std ::
..
记录spring（boot）配置属性
我正在寻找一个解决方案来为我的应用程序中使用的弹簧配置属性创建文档。 例如，我有以下类“Person”的定义使用application.properties文件中的属性“person.age”来设置该人的年龄。 public class Person { @Value（“$ {person.age：21}”） 私人年龄; public Person（）{} priv
..
当我从外部库类继承时，如何在phpDocumentor解析器中停止警告？
我已经在我的代码中添加了docblock，并解决了phpDocumentor脚本生成并放置在errors.html文件中的大部分构建错误和警告。 然而，在我当前的文档编译中，我有一个最后一个'class'的警告 - 我收到了一个在我的应用程序中记录的继承自外部库（在本例中是Zend）的类的警告。 p> 有没有办法停止警告，例如警告 - 类AMH_Controller_Action父Ze
..
向JavaScript函数添加文档的标准方法是什么？
我正在考虑为JavaScript项目生成API文档。 JavaScript有什么类似Python的docstring？ function add（a，b）{ / ** 返回“a”和“b”的总和。 * / return（a - 0）+（b - 0）; } 解决方案 你看过 JSDoc （现已被 JSDoc工具包 ）？
..
如何使用appleDoc来记录私有（非公共接口）？
最近我已经学会了如何使用appleDoc来做我的iphone项目的文档。 但是我意识到的是，AppleDoc只扫描每个类和基于特殊的注释格式，它创建了docSet和html。 我的问题是如何让AppleDoc照顾.m文件。因为对于像viewController这样的类，在.m扇区中有很多逻辑，不会在头文件中公开。 （我问这是因为在Xcode5中，如果你悬停在一个私有的方法，并按“选项”
..
如何生成我的Laravel项目的文档？
我想生成我的Laravel项目的文档。框架有一个工具吗？除了API文档生成器外，我找不到任何东西。 解决方案 是的，Laravel和PHPDocumentor一起去。请阅读此处了解如何为您的项目生成文档。 phpdoc -d path / to / my / project -f path / to / an / additional / file -t path / to / m
..
生成的文档是否应该进入源代码控制？
最近（最后）我已经开始记录我的一个开源项目。该项目是.Net的类库。我使用Doxygen从源代码生成HTML文档。 现在，我的问题是应该存储Doxygen在我的源代码控件中生成的HTML文件吗？ 解决方案 您是否认为每次提交代码时都可以重建文档？否则，您的文档将很快变得不可靠，因为它可能 - 或者可能与您的代码不一致。 但是我明白这是很难决定的，因为特别如果您的项目是启动/小型
..
如何生成facelets文档？
对于JSP和某些 JSF标签，有一个名为 TLDdoc 为JSP和JSF标签生成JavaDoc样式的文档。 有没有人知道Facelets的等价物？有一个名为 facelets-doc 的工具，旨在支持Facelets，但尚未完成，或缺少文档没有提到如何使其工作。 我有一些面孔taglib.xml文件定义标签和函数，并希望得到类似于什么TLDdoc生成（示例）。有没有人知道TLDdoc是
..
在Sphinx的参考文献中保留内联代码
在狮身人面像中，如果我有以下标题声明： .. _somestuff： “这是代码”，这不是！ ============================ 它呈现如下： 这是代码，这不是！ 哪个是好的，但如果我使用引用，例如： 看看：ref：`somestuff` 它丢失了代码格式并呈现如下：
..
替换python docstrings
我已将 epytext 写入 reST 标记转换器，现在我想将我的整个库中的所有docstrings从epytext转换为reST格式。 是否有一种聪明的方法来读取模块中的所有文档字符串并写回替换？ ps： ast 模块可能？ 解决方案 Pyment 是一种可以转换Python文本字符串并创建丢失的骨架的工具。它可以管理 Google ， Epydoc （javadoc样式），
..
JSDoc'ing写在“显示模块模式”中的Javascript文件的最佳实践样式？
我的大部分Javascript函数都比较简单，并且对它们的sideeffect有所帮助：我使用jQuery来操纵DOM或进行Ajax调用。我更喜欢在“透露模块模式”中写我的功能。 我刚刚发现 JSDoc-注释的Javascript文件有一个好处：帮助的注释，Eclipse的JS开发工具可以解析我的JS文件， 填写Eclipse Outline视图（否则为空）。 现在我不知道什么是精细点
..
doxygen是（事实上）标准文档语法规范吗？
我们都有记录我们的代码的好习惯，对吧？ 现在，代码内的文档本身有一个语法。它几乎像一个编程语言本身。问题是： 存在什么（多少）文档语法规范 是否有标准的文档语法？ 谁定义了这个标准？是否有官方委员会或机构（像定义C ++标准一样）？ 还是有“doxygen”成为事实上的标准？ 听说过doxygen。在我参与的每个开源软件项目中都提到了，但是看官方的doxygen网站，很显然
..
有关开源项目的文档建议？
我们正在考虑记录一个刚刚起步的开源项目，我希望有一些关于好的建议方法和/或工具，为您效果良好。此外，作为开发人员，您更喜欢在线文档，基于wiki的文档，帮助文件还是其他？ 解决方案 您的应用程序正在C＃中开发，请查看生成API文档的 Doxygen 。它是非常强大的（它执行标准的javadoc样式成员文档，但也会生成调用，继承，文件依赖关系和协作图）。尽管它的力量很容易使用。它可以生成无数
..
如何将C＃Xml Doc-Comments转换成有用的东西？
我想将Xml文档从大型项目编译成易于阅读和搜索的形式，希望比浏览原始源代码更方便。只要可用，我并不特别担心最终格式 - CHM，HTML，xyz。能够容易地滚动（或链接）附加内容将是一个加分。 NDoc 曾经是事实上的标准，但该项目没有显示现在的生活迹象（最后一次更新可以看到是2005年2月19日）。 Sandcastle 似乎取代了NDoc作为通用标准，但我从来没有设法得到它运行可靠
..
如何编写包文档？
我并没有想出一个合理的工作流来构建软件包并撰写他们的文档。 我想要尽可能多的过程（和文档）要自动生成。 这样做的明显方法似乎是使用 package.skeleton 来创建基本的包文件，然后以编程方式覆盖 DESCRIPTION 文件和 Rd 文件。这样做的麻烦在于，您将丢失自动生成的字段，确保您记住所有正确的参数。 我想知道如何>你关于构建包和编写文档。他们有任何工具可以使流程
..
Sphinx为php代码文档
Sphinx是一个Python库，用于从一组ReST格式的文本文件生成不错的文档。不是用于全文搜索的工具 我还完全了解doxygen / phpdoc工具。我想弄清楚是否有一种使用Sphinx来记录php项目的方法？甚至任何其他非蟒蛇语言？ http：// sphinx.pocoo.org/ 解决方案 根据我的经验，Sphinx和ReST可以用作通用文档工具。没有什么关于Sph
..
LaTeX可用于生产随软件附带的任何文档吗？
虽然与这个关于LaTeX在数学和学术界之外使用的问题有关“ a>，我特别想知道是否有人使用或熟悉使用LaTeX生成与软件有关的任何类型的文档的任何人。如果是这样，可以说你是否喜欢LaTeX和你使用它的目的？谢谢。 解决方案 我主要用LaTeX撰写学术论文。然而，我的研究与软件文档有关，所以我实际上处理了一些这些问题。 LaTeX最好的是你关心内容和结构，不仅仅是视觉布局。这就像使用C
..
有谁知道一个CSS文档工具？
我们最近使用OOCSS原则重建了我们的网站，这些原则允许一个真正模块化的方式来编写CSS。 该网站很大，并且有很多开发人员可以使用它所以我想要能够记录CSS，以便CSS模块尽可能高效地重用。 有没有人有使用自动化的CSS文档工具的经验？或者使用另一个文档工具来使用CSS文件？ 解决方案 CSS_DOC CSS_Doc 。解释它的博客文章。 还有一个文档评论的例子
..
ECMAScript 6文档生成器
我正在寻找EcmaScript 6的文档生成器。我没有找到一个。 JSDoc 3不支持 https://github.com/jsdoc3/jsdoc/issues/555 Docco没有发现 SmartComments没有发现但不太可能，太小的项目 没有找到YuiDoc NaturalDocs没有找到但没有关注JavaScript 没有找到SphinxDoc 那么真的没有文
..