documentation相关内容
我了解: conf.verb = 0 禁用Scapy冗长模式,但是文档可以在哪里确认这一点? 我的谷歌搜索使我失败了。 / p> 解决方案 实际上, conf 的文档字符串指定配置 conf.verb = 0 将详细程度设置为几乎静音,这意味着它不会完全禁用它。 文档字符串的相关摘录如下: verb:详细程度,从0(几乎静音)更改为3
..
我正在研究R包。 我以这种方式为某些函数设置别名: foo
..
在socket.io文档中,他们使用的外观看起来不太像javascript(尽管它是一个javascript库)的命名法。 此处的示例: http://socket.io/docs/client-api/ (此页面已更改,因为这是截至2014年的网络存档快照) 这个很清楚(仅指定参数类型和返回值): IO(url:String,opts:Object):Socket
..
我今天第一次尝试使用PHPDoc,很快就遇到了问题。 每1行变量声明中,我至少有5行注释。示例: / ** *保存远程服务器 的路径* @name ... * @global ... * / $ myvar = ... 当然,收益很好-但这会将10行的配置文件转换为60行的文件。我花了很长时间来填写,但我还不相信它会在简单的单行代码中增加很多。
..
我正在寻找一种为嵌套函数生成文档(在这种情况下为pydoc)的方法。 pydoc有可能吗? 例如: ”可以吗? “” 模块文档字符串。 “”“ def foo(x): ”“” Foo执行某些操作。 “ “” ... def bar(y): “”“ Bar执行 ”“” .. 。 使用以下命令生成pydoc:pydoc -w -filena
..
我试图在Windows中为Visual Basic使用Doxygen过滤器。 我从基于gawk的Vsevolod Kukol过滤器开始。 没有太多方向。 所以我开始使用他自己的VB代码 VB6Module.bas ,并通过他的 vbfilter.awk ,我发出: gawk -f vbfilter.awk VB6Module.bas 这将在stdin上输出类似C
..
如果您将MainPage.dox文件放在Doxygen的搜索路径中,则会将其添加到源文档上方Doxygen / html中的输出中。但是您可以拥有MainPage.dox这样的多个文件吗?还是仅限于一个? 解决方案 Doxygen将识别并解析任何带有* .dox扩展名的文件,并将其包含在结果文档中。这些文件将产生什么,取决于文件中的doxygen注释。例如,如果要修改主页,则需要这样的注释
..
在 help()设置类时,我在许多文档字符串中看到以下语句:“请参见 help(type(self)) 以获得准确的签名。” 值得注意的是,它在 help()中 scipy.stats.binom .__ init __ 和至少 stockfish.Stockfish .__ init __ 。因此,我认为这是某种股票信息。 无论如何,我不知道这到底意味着什么。这是有用的信息吗?请注意
..
是否应该有2个不同版本的用户指南使用不同的规范URL ? 文档版本 1.1.0最终: 文档版本 1.2.0.Final :
..
我正在一个需要Numpy文档的项目中。在我使用Java的日子里,我记得曾在Linux / IDEA中检查过Javadoc遵从性的短毛猫。 我知道PEP257,但似乎没有针对Numpy文档的任何特定检查。 > 解决方案 Pylint似乎支持这一点。看看 pylint.extensions.docparams 。 总结一下。您可以通过添加 load-plugins = py
..
Python文档说,“用于Python文档的标记是 reStructuredText ”。我的问题是:应该如何编写块注释以显示多个返回值? def func_returning_one_value(): “”“仅返回一个值。 :返回:一些值 :rtype:str ”“” def func_returning_three_values() : “”“返回三个值。 我如何在r
..
我正在浏览PHPDoc的文档,找不到找到将我发送给各种方法的Post变量的好方法。 因此,我开始希望对Doxygen有所了解,希望它将为我提供记录所有这些变量的更好方法。我的代码涉及很多AJAX请求,因此大多数变量是通过post发送的。 我是否有一个很好的方法来记录doxygen中的post变量?我无法确定仅使用标准参数代码运行是否会出错。 如果没有,在此过程中是否还有其他记录员
..
当sphinx处理从rst到html的转换时,是否有办法在处理扩展名后看到中间格式? 我正在寻找在sphinx之后生成的中间rst文件扩展已运行。 有什么想法吗? 解决方案 看看“ ReST构建器”扩展名: https://pythonhosted.org/sphinxcontrib-restbuilder/ 。 没什么可说的;扩展名将reST作为输入和输出... dru
..
上下文-Doxygen工具,使用C代码生成RTF文档。 在模块/组的文档中,即使没有,也会得到标题“详细说明”在某些特定的模块/组中提供了详细说明。 在生成的RTF文档中,这看起来很难看。 我尝试了“ ALWAYS_DETAILED_SEC = NO” ,但是有可能摆脱这种空的“详细描述”部分吗?不管用。我不能执行“ HIDE_UNDOC_MEMBERS = YES” ,因为组/
..
我觉得很不言自明 解决方案 我在这里猜测,但是如果这是您的类库,确保您确实构建了XML文档文件,否则方法摘要将仅在同一程序集中提供。 Project Properties-> Build Tab-> Output部分->检查“ XML文档文件” 很明显,正如Mitchel指出的那样,您也必须导入它,但这通常在添加程序集引用时自动执行(如只要存在)。
..
我需要使用pydoc从注释生成文档。这样做的基本步骤是什么? 解决方案 如果您真的想使用Pydoc,可以在终端中简单地做: $ pydoc -w myproject 此会从命令生成老式的HTML文档。 请注意,Pydoc是从2.1开始在Python中用于 help()函数的模块。 它将检索不是注释的 docstrings 。您应该使用docstrings来描述
..
我要编写一组脚本,每个脚本彼此独立,但有一些相似之处。所有脚本的结构都可能相同,并且可能看起来像这样: #-*-编码:utf-8-*- “”。 小描述和信息 @author:作者 “”” #导入 导入numpy为np 导入数学 从scipy导入信号 ... #常量定义(总是大写字母可变) CONSTANT_1 = 5 CONSTANT_2 = 10 #主类 类
..
我有一个预先存在的MVC应用程序,我使用Nuget添加了Web API和Web API Self Documentation。虽然Web API控制器可以正常工作(返回对HTTP请求的有效响应),但Help控制器找不到任何要记录的Web API方法。 在“ Help controller Index Action”中Configuration.Services.GetApiExplorer(
..
假设我的包中有一个函数闭包,例如 f = function(x){ x = x g = function(y)x
..
例如,在@details部分中,将逐项列表添加到roxygen2的适当语法是什么?我可以创建乳胶列表环境吗? 似乎只是简单地忽略了换行符,即 #'@详细描述参数输入的文本 #' #'参数1:填充 #' #'参数2:填充 谢谢! 解决方案 这里是遵循问题表达方式的roxygen2示例。 ##' ##' @details详细描述参数输入的文本。 ##
..