我正在写一些javadoc,并想知道如何强调out参数.
我现在正在这样做(非常简单)
/**
* @param cl (IN Parameter) description here <br/>
* @param nodes (OUT Parameter) description here <br/>
* @param holotypes (OUT Parameter) description here <br/>
*/
public void getNodes(List<O> cl, List<Node<O>> nodes, List<O> holotypes) {...}
是否有可能在sphinx文档生成器中使文本删除？
我试图在phpdoc中记录私有变量,但它没有记录.
这是我的代码:
class Content
{
/**
* simple db class variable
* @access private
*/
var $_db = null; // db
private $_s3 = null; // s3
/**
* queue for mainting session queue1
*/
public $queue = array();
}
在$_db与$_s3两者都没有在文档中来.
在python中,我知道我应该像这样记录实例变量:
self.x = 22
"""docstring for x"""
#: docstring for x
self.x = 22
self.x = 22 #: docstring for x
但我似乎无法找到一种方法来获取代码中的文档.MyClass.x.__doc__给我一个实际类型的文档x
所以,问题是:如何获得"docstring for x"从self.x？
我似乎无法找到任何关于POS终端的SPDH协议的文档.如果有人能指出我的话会非常有帮助....谢谢
编辑:忘了提到我确实看过这个问题,但文档的链接不起作用... SPDH框架的分析器
当在函数上使用phpdoc我有一个总是包含一个类的实例的参数时,有没有办法在phpdoc中记录这个,以便生成的phpdoc链接到给定的类？
有点像@param MyClass() $var.
我在文档中找不到任何关于它的信息,实际上文档甚至没有提到对象(stdClass)类型参数,句点.
我有一个合理的大型C / C ++项目，只想由Doxygen生成文档的HTML版本。在我Doxyfile写的
GENERATE_LATEX = NO
实际上，latex指定的输出目录中没有目录。只是html。但是，我在stderr上得到pdfTex的输出：
...
This is pdfTeX, Version 3.1415926-1.40.11 (TeX Live 2010)
restricted \write18 enabled.
entering extended mode
(./_formulas.tex
LaTeX2e <2009/09/24>
...
Output written on _formulas.dvi (279 pages, 49376 bytes).
Transcript written on _formulas.log.
...
为什么？
Doxygen的安装说明将LaTeX列为可选（附加）工具，并非必需。因此，我认为HTML生成的基本功能不是必需的。
如何使Doxygen无法执行pdfTex？（不，我不想在计算机上卸载* TeX）
如何在Windows上构建Go 1文档？它在我的机器上的D:\ go\doc下,所有链接和路径都被破坏了.
我希望将HTML SE 7文档从HTML导出为可解析的XML.
无论是使用像Perl这样的脚本语言,还是直接从Java(可能使用Eclipse)完成,我都愿意接受建议.也许某人已经做过了吗？
我需要API的Javadoc中提供的大部分数据,因此需要手动执行永久性操作.我不是在寻找代码,我可以自己解决这个问题,我只是在寻找一些关于这样做的想法,因为我确信这是一种"简单"的方式,而且我不想浪费太多时间这样做,后来发现我可以在另一个方面做得更快.
并不重要,但我会用C#阅读XML.
我知道这是一个奇怪的问题,但我不知道还能在哪里问.