documentation相关内容

在Sphinx中，如何包括位于模块中但类和方法之外的文档字符串/注释

我的包裹中有一个 utils 模块。它由几个不需要实例化的杂项独立方法组成。 我想在此 utils 文件，例如： import os import json “ “” 可以帮助> 的其他方法不需要显式实例化。 可以执行以下操作： = ============================ 操作方法 =========== ==== ..

发布时间：2020-06-06 19:46:34 python-2.7 documentation python-sphinx autodoc 其他开发

如何在PhpDocumentor中显示继承方法的完整文档块？

我目前有一段代码，其中有一个抽象的父类定义了一些具体方法，而子类则扩展了该父类，并将使用具体方法。例如： ..

发布时间：2020-05-31 22:27:44 inheritance documentation abstract phpdoc 其他开发

SandCastle帮助文件生成器：搜索不起作用

我刚刚下载了最新版本的Sancastle帮助文件生成器2017.1.28.0。 根据这篇文章的回答和评论，我期望进行搜索工作，但没有。 无论我要搜索什么，我都会收到一条“找不到任何内容” 消息。 BTW，我没有生成任何aspx文件。 我尝试使用Google Chrome浏览器 我会错过任何项目配置吗？ 如何使搜索有效？ 解决方案 所描述的行为似乎取决于所使用的浏览器 ..

发布时间：2020-05-30 20:20:08 .net visual-studio search documentation sandcastle C#/.NET

从邮递员集合中创建HTML文档

我已经开发了一个漂亮的扩展API，并且在Postman上有它，效果很好。现在，我必须生成一个html文档，以使其在/ docs以及其源代码中保持版本。 有没有工具或方法可以实现此目的？我真的不想写所有这些文档。 解决方案 我最近遇到了同样的问题，但没有发现任何问题。因此，我创建了一个简单的工具来执行此操作。这是一个用react.js编写的非常基本的javascript应用程序。目前， ..

发布时间：2020-05-30 02:12:09 api rest documentation documentation-generation postman 其他开发

在PDF文件中使用JavaScript代码的文档

在PDF中运行JavaScript代码时，在哪里可以找到文档? 我从未在PDF文档中添加JavaScript操作.但是，我已经使用JavaScript完成了很多Web开发.对于那些对PDF文档中的JavaScript有任何熟悉的人，我有几个问题. NitroPDF和Adobe Acrobat绝对支持PDF文件中的JavaScript. 是否存在关于各种对象的标准，以及通过JavaScr ..

发布时间：2020-05-25 03:46:34 javascript pdf documentation acrobat pdf-manipulation 前端开发

熊猫"Freq"标签的文档在哪里?

我是Pandas的新手，正在尝试使用date_range.我遇到了freq的各种好东西，例如BME和BMS，我希望能够快速查找适当的字符串以获取所需的内容.昨天我在文档中的某个地方找到了格式良好的表，但是表的标题太晦涩，以至于我今天无法使用搜索再次找到它. 解决方案 您可以找到名为 许多字符串别名被赋予有用的公共时间序列频率.我们将这些别名称为偏移别名(称为v0.8.0之前的时间规则). ..

发布时间：2020-05-23 21:36:58 python pandas documentation dataframe frequency Python

在R包中记录特殊(中缀)功能

在先前的帖子中，我询问了有关声明此类功能的问题在R包中并使它们工作.成功之后，我现在正在尝试记录一个这样的功能. 我创建了一个以函数名称作为标题的Rd文件，但是在运行CHECK时，出现以下警告: * checking for missing documentation entries ... WARNING Undocumented code objects: '%IN%' 我 ..

发布时间：2020-05-23 19:49:05 r documentation package infix-notation 其他开发

在R-package文档(.Rd)文件中包含图像

我正在努力在我的软件包中记录可视化功能.为此，我想通过Rd文件'funcname.Rd'嵌入一个图像，该图像可以解释该函数中使用的各种参数，并且如果用户去阅读软件包手册PDF或写'?funcname，则该图像会弹出. R中的内容. “编写R扩展"文档似乎无法解决此问题，我只能找到此R-devel讨论.前者指向名为"base64"的程序包的链接断开，而后者仅解决了各种替代方法，例如将图像包含在 ..

发布时间：2020-05-23 19:35:57 r documentation package visualization rd 其他开发

使用相同的XML注释记录重载方法

说我有这个构造函数: /// /// Example comment. /// public SftpConnection(string host, string username, string password, int port) {...} 具有这些重载: public SftpConnection(string host ..

发布时间：2020-05-22 20:47:12 c# xml documentation overloading xmldocument C#/.NET

使用OpenSSL库在C ++中生成SHA-3哈希

我已经广泛搜索了一个代码示例，该示例使用OpenSSL最近实现的SHA-3算法进行哈希处理，但找不到任何示例.在SHA-1和SHA-3上有代码示例，但是在库文件夹中快速搜索显示OpenSSL v1.1.1中甚至没有SHA3函数名称? 我到处搜索过，但这是相对较新的内容，因此我无法找到有关新算法的任何特定信息. 我发现此线程使用OpenSSL库在C ++中生成SHA哈希涵盖了SHA-1和 ..

发布时间：2020-05-21 02:34:52 openssl documentation sha-3 其他开发

Swagger是否可以基于现有的快递路线自动生成其Yaml?

我继承了一个现有的API，我想大张旗鼓地记录下来，但是我还不知道它的全部范围. Swagger(或其他中间件/工具)是否可以根据现有的快速路线自动生成Yaml(用于swagger)? 对于我在其他问题上看到的内容，看来这主要是一项手动工作，但我正在仔细检查这里是否有人找到解决方法. 解决方案 我在自动生成Swagger json并将其手动写入为我帮助构建的API方面都有经验.根据我的 ..

发布时间：2020-05-18 01:57:18 node.js rest express documentation swagger 其他开发

可以在NetBeans中查看方法/函数文档吗?

具有Python支持的NetBeans 6.5在自动完成时为弹出窗口中的函数/方法提供了文档字符串文档，但是还有另一种查看文档字符串的方法吗? 是通过鼠标悬停在函数/方法名称上还是单击某个位置来实现的? 我似乎能做的最好的事情就是右键单击菜单中的“转到源代码". 解决方案 我在Sun收到了Tor Norbye的以下答复: 按住ctrl键(或在Mac上为Cmd)，然后将鼠标 ..

发布时间：2020-05-17 02:00:33 netbeans ide documentation 其他开发

有关使用Linux线程优先级和调度策略的指南?

我在Linux上无法掌握线程(/进程)优先级的问题，计划策略选择，何时何地选择什么以及实际效果如何. 在某处是否有任何文档(例如指南)，最好是具体的示例和时间表，我可以参考这些文档和时间表? 解决方案 我无法在Linux上挂起线程(/进程)优先级的问题，无法调度策略选择 优先级通过利用底层OS的线程和进程优先级来起作用，并且很难从文档的角度概括其具体细节，这也许就是为什么您 ..

发布时间：2020-05-14 01:44:38 linux multithreading documentation conventions thread-priority 服务器开发

如何使用python-docx在MS Word中添加页面间链接?

我正在创建一个文件，其中包含第1页第4页上的文本数据以及第5页以上的所有图像. 有一个表，其中页码为列.我想通过单击该页面编号所引用的图像页面来为该列中的每个页面编号添加链接. 我正在使用python-docx创建此文档. 在google上绊脚石时，我得到了使用python-docx创建超链接的解决方案.单击带有超链接的文本会将我带到它所引用的URL. 超链接的代码如下: ..

发布时间：2020-05-13 01:38:30 python ms-word documentation python-docx Python

Java 8 LocalDate大张旗鼓地显示

我有一个DTO，其中包含Java 8 LocalDate类型的字段.使用Jackson批注，可以将format设置为ISO.DATE，并且一切正常.但是Swagger(我的版本为2. +)将LocalDate.class作为对象 LocalDate { month (integer, optional), year (integer, optional) } (是的，但是...)我想把它 ..

发布时间：2020-05-09 19:58:06 java documentation swagger microservices swagger-2.0 Java开发

调用help(MyClass)还显示基类属性:如何避免这种情况?

MyClass源自“列表":MyClass(list) 我想很好地记录MyClass. 不幸的是，当尝试帮助(MyClass)时， 我有自己的文档，但也有很多有关“列表"的内容. 会有一种简单的方法来控制它吗? 我读了一些有关元类的东西，但我却无能为力. 感谢您的建议， 米歇尔 解决方案 好吧，这就是help的作用.它会对您的类进行自省，并为该类中的每个可调用属性显示名称 ..

发布时间：2020-05-09 01:46:07 python-3.x documentation metaclass derived 其他开发

防止在reStructuredText中将节标题转换为字幕转换

在reStructuredText中，标题和下层标题作为副标题被读取: Section 1 ========= Subtitle -------- 但是，如果我实际上希望小节标题紧跟在小节标题之后，该怎么办?根据文档，空注释“用于终止先前的构造" ，但这似乎不适用于此，因为 Section 1 ========= .. Section 2 --------- 仍然变成 S ..

发布时间：2020-05-06 04:14:32 documentation markup restructuredtext 其他开发

如何使用Markdown在标题标题为带空格的句子的情况下对同一文档的各节进行链接引用?

这可行 1. [Notifier system requirements](#requirements) 这不起作用 1. [Deployment steps](#steps to deployment) Steps to deployment和requirements是我的README.md文件中的标题/节标题. 解决方案 通过将其悬停或使用浏览器的devtools检 ..

发布时间：2020-05-06 03:53:13 markdown documentation github-flavored-markdown multimarkdown 其他开发

Swift中块参数文档的标记格式是什么?

如果您添加文档标记，Swift中一个块的参数将显示一个表，其中包含块的参数，但是我不知道如何填写该表.我已经在 Xcode标记参考格式，但是我找不到任何内容. 示例: /** Foo - parameter completion: A block to execute */ func foo(completion: (Bool) -> Void) { // do som ..

发布时间：2020-05-06 03:48:49 swift xcode documentation markdown markup 移动开发

如何在Doxygen的降价文档之间链接?

我有一个项目，其中包含一组降价页面，这些页面与链接(例如， [Go to this page](subdir/MyOtherPage.md) 所有页面都被doxygen拾取并显示在输出中，但是链接并未更改以指向其新的html格式. 我可以更改指向html页面的链接，但是我的项目托管在github上，然后这些链接将被破坏，因为github支持自动在markdown页面之间进行链接. ..

发布时间：2020-05-06 03:42:38 documentation markdown doxygen 其他开发