-
2 votesanswersviews
Python Sphinx记录包的公共接口
我有一个包含子模块的Python包 . 目前，我的目的是允许使用包出口的功能，例如： package_X +-- __init__.py +-- submodule_A.py +-- submodule_B.py 子模块是实现细节 . 包的用户需要知道的所有内容都将导出到 __init__.py 文件中 . 现在，在使用Sphinx构建文档时，我获得了TOC和文档，如下所示： package_X... -
8 votesanswersviews
在Sphinx文档中保留包装/修饰Python函数的默认参数
如何将 *args 和 **kwargs 替换为装饰函数文档中的真实签名？ 假设我有以下装饰器和装饰功能： import functools def mywrapper(func): @functools.wraps(func) def new_func(*args, **kwargs): print('Wrapping Ho!') return ... -
0 votesanswersviews
SignalR面向公众的API
在我正在开展的项目中，我们正在开发面向公众的API，以便第三方通过我们的解决方案进行集成 . 我们需要实现“实时更改通知”，这意味着服务器需要注意客户端某些资源已更改 . API将由专有应用程序，移动应用程序和Web应用程序使用，因此该技术的一般易用性非常重要 . 我正在考虑多种技术，如网络套接字，SSE，长轮询和SignalR . 由于我之前曾与SignalR合作过，而且作为后端开发人员使用它很... -
0 votesanswersviews
如何使用pandoc将特定网页转换为markdown或asciidoc？
我想将java specification documentation转换为易于编辑的格式（markdown或asciidoc）并上传GitHub Gist并自定义（添加我的代码体验和注释 . ）我想转换为something like this 我使用一个名为pandoc的工具，它允许我们从HTML转换为markdown . 我试过以下： Technique 1 我试图在index.html上转换... -
640 votesanswersviews
什么是标准的Python文档字符串格式？ [关闭]
我在Python中看过几种不同风格的文档字符串，是否有官方或“同意”的风格？ -
1 votesanswersviews
为swagger UI wildfly swarm指定swagger.json url
我有Wildfly Swarm的REST应用程序，并使用默认设置我在url / swagger或/swagger.json上使用swagger.json，在url / swagger-ui上使用swiger . 但默认情况下，UI从示例中解析petstore . 如何为我的json文件配置UI的默认路径？我有下一个swagger的依赖： <dependency> <gro... -
3 votesanswersviews
如何根据功能标志有条件地执行模块级doctest？
我正在编写一个模块的文档，该模块有一些由Cargo功能标志控制的选项 . 我想总是显示这个文档，以便crate的消费者知道它可用，但我只需要在启用该功能时运行该示例 . lib.rs //! This crate has common utility functions //! //! ``` //! assert_eq!(2, featureful::add_one(1)); //! ``` /... -
19 votesanswersviews
禁用所选文件的“文档注释”警告
Xcode能够检查文档注释问题，并在出现问题时报告警告 . 例如，我使用CocoaPods将Facebook SDK添加到我的项目中 . 在 FBError.h 文件中的某个位置，有以下代码： /*! @typedef NS_ENUM (NSInteger, FBErrorCategory) @abstract Indicates the Facebook SDK classificatio... -
1 votesanswersviews
用于记录API的Wiki软件[关闭]
什么是记录和共享API（例如HTTP Web服务）的可行方法？ 要求是： 任何人都可以编辑任何页面的Wiki类型系统 . 编写API规范的简便方法，以便自动应用样式/格式，而不必为每个单独的页面手动添加样式 . 我会使用Wordpress，除了它更像是一个博客引擎 . 我想要一个漂亮，干净，结构化的页面层次结构，并且能够立即实现 click and edit . 我试过Google ... -
2 votesanswersviews
记录Kotlin中函数参数的参数
假设我有一个更高阶的函数，它注册了某种点击监听器 . 我可以记录它的用途以及传入的 listener 参数： /** * Adds a [listener] that's called when the item is clicked. * * @param listener The listener to add */ fun addClickListener(listener: (co... -
244 votesanswersviews
什么是自我记录代码，是否可以替换记录良好的代码？ [关闭]
我有一位同事坚持认为他的代码不需要评论，而是“自我记录” . 我已经回顾了他的代码，虽然它比我见过其他代码生成的代码更清晰，但我仍然不同意自我编写代码是完整和有用的以及评论和记录的代码 . 帮助我理解 his 的观点 . 什么是自我记录代码 它真的可以取代评论和记录良好的代码 是否存在比记录良好和注释的代码更好的情况 是否存在代码无法在没有注释的情况下进行自我记录的示例 也许这... -
10 votesanswersviews
来自Spring Hateoas的文件HAL“_links”（带着招摇）？ [关闭]
我有一个REST服务，我想为我的客户开发团队记录 . 所以我从 Spring-Hateoas 添加了一些 Links 到我的资源API，并插入它 swagger-springmvc @Api... 注释来记录所有内容，并为我的Angular团队提供一个很好的API参考，以便能够理解我的REST服务 . 问题是 swagger 无法发现可能的链接，只是给我一大堆 Links 而不说出他们可能的值... -
0 votesanswersviews
自动生成RESTful API示例JSON [关闭]
我在Jersey 2.17上有一些RESTful API和Jackson . 它们都是JSON风格，并且运行良好 . 但我想为开发人员生成一个好的RESTful Docs withJSON示例 . 所以我尝试了一些maven插件， 首先我试过ServiceDocGen Maven Plugin， 它使用Json示例直接生成HTML文档 . 但它不知道像@JsonProperty，@ JsonIgn... -
2 votesanswersviews
Ceridian Dayforce HRIS API位置[关闭]
我们公司正在考虑将Ceridian Dayforce人力资源管理系统与我们的产品连接起来 . 现在我被要求估计这样做所需的时间和精力 . 问题是，我找不到API的文档源 . Dayforce似乎提供了一个API，例如他们有一篇文章似乎表明他们支持API集成，但数据表本身就是一个页面大小，并且纯粹以非技术方式编写 . 我想知道：这些文件是否有任何公开来源？如果没有，这是否意味着没有可用的API或只... -
0 votesanswersviews
c /在目录和文件上查找文档（如dirent.h）？ [关闭]
我正在寻找关于C代码的文档和目录实现到C程序的文档 . 我喜欢去cplusplus.com因为他们有文件和例子，但是我找不到dirent.h上的文档，我甚至不确定它是多么好 . 我希望有一个程序能够在目录中查看，这意味着获取其中的文件和子目录的列表，以及能够获得此类事物的修改/创建日期 . 我在Ubuntu Linux中编程 . -
23 votesanswersviews
doxygen是（事实上的）标准文档语法规范吗？ [关闭]
我们都有记录代码的好习惯，对吧？ 如今，代码内文档本身就有一种语法 . 它几乎就像一种编程语言 . 问题是： 存在多少（多少）文档语法规范？ 是否有标准的文档语法？ 谁在定义这个标准？是否有正式的委员会或机构（就像有一个定义C标准的那样）？ 或"doxygen"成为事实上的标准？ 很难不听说doxygen . 在我参与的每个开源软件项目中都提到过 . 但是，... -
2 votesanswersviews
Doxygen自定义元素和列表
What I want to achieve: 我想在Doxygen生成的文档中列出某些内容（想想 todo ，在我的例子中，它们是任意的 Summons ） . 我想使用自定义项目（ \summon ），因此我可以列出文件中记录的所有 Summons 列表，并生成一个页面，列出整个系统中的所有项目，按文件拆分 . （我只关心在这里生成HTML文档，而不是乳胶 . ） 这是一个例子： 在Foo.c... -
0 votesanswersviews
sphinx，kivy和autodoc：警告和创建文档的问题
我想在Sphinx中创建我的代码文档 . 我安装了一切并做了一些简单的试用，运行正常 . （我运行sphinx-quickstart，编辑conf.py以包含模块的路径，使用教程来了解sphinx如何工作等等） 然而，我的代码导入了许多kivy库 . 当我想在导入kivy的模块上创建文档时，它会失败 . 例如，如果我有这样的main.py： #!/usr/bin/python # -*- cod... -
34 votesanswersviews
Swagger可以根据现有的快速路线自动生成其yaml吗？
我继承了现有的API，我想用swagger记录它，但我还不知道它的全部范围 . Swagger（或其他中间件/工具）可以根据现有的快速路线自动神奇地生成yaml（用于招摇）吗？ 对于我在其他问题上看到的情况，似乎这主要是一个手工工作，但我仔细检查是否有人在这里找到了办法 . -
1 votesanswersviews
在同一 endpoints 支持两个不同的请求主体
我需要为同一个 endpoints 和相同的方法（POST）支持两种请求体 . 在Swagger有可能吗？ 这很重要，因为两个请求体都是有效的，用户可以发送其中任何一个 . 进一步来说， RequestBody 1: { param1: value1 param2: value2 param3: { param3Key1: x1 param... -
19 votesanswersviews
学习Linux x86-64汇编和文档的建议[关闭]
有没有人有关于学习Linux x86-64程序集基础知识的文档？我不确定是否要按原样学习它，或者先学习x86，然后再学习它，但是因为我有一台x86-64计算机而不是x86，我正在考虑学习x86-64; ） 也许有人可以给我一些激励，并指导学习什么，如何以及用什么文档 . 请给我你最喜欢的文档 Headers ，我编写一些Python，这是我第一次尝试低级语言，而且我已经准备好专注于它 . 谢谢大家... -
34 votesanswersviews
是否有Silverlight 4控件的默认键盘行为参考？ [关闭]
在官方的Microsoft文档中，只有一个段落提到了控件对键盘的行为（至少我能找到的）： http://msdn.microsoft.com/en-us/library/cc189015(v=VS.95).aspx#inputting_text 文本输入和控件某些控件通过自己的处理对键盘事件做出反应 . 例如，TextBox是一个控件，用于捕获然后直观地表示使用键盘输入的文本，它在自己的逻辑中使... -
4 votesanswersviews
如何设置阅读文档以便Sphinx autodoc选项有效？
我的项目没有't building with autodoc. I' m进入this frequently asked question about my project not building in autodoc . 但是，一些依赖项包括不能在Build the Docs服务器上执行的c代码 . 所以我在这个blog explaining that I should use mock中阅读了... -
0 votesanswersviews
如何在sphinx中包含模块
我一直在寻找这个问题的答案一个星期 . 希望你能帮我： 我正在使用Sphinx进行记录，这是我项目的结构： -folder __init__ -main_tool_folder __init__ main.py -docs_folder -modulefolder __init__ fileIw... -
1 votesanswersviews
AWS Api-Gateway Lambda代理 endpoints 的Swagger定义
仅供参考 - 我已经检查了与此相关的类似问题，但没有一个能解决我的问题 . 我正在尝试为AWS Api-Gateway下的许多API创建Swagger定义 . 我能够从我从API Stage下载的自动生成的YAML配置中成功地为其他（POST，GET） endpoints 执行此操作 . 但是当我尝试使用Lambda代理集成为Api-Gateway endpoints 执行相同操作时遇到了问题：E... -
0 votesanswersviews
PHPDocumenter没有关于类的摘要
我正在使用PHPDocuementer，我继续为我的类获取这些消息： Parsing /code/vendor/prodigyview/helium/app.class.php No summary for class \prodigyview\helium\He2App 但是当代码如下： <?php /** * The main application for instantiai... -
30 votesanswersviews
JavaScript DOM API在哪里记录？ [关闭]
我是一名C / C程序员，我目前正在玩一些Javascript代码，而且我在查找文档的位置时遇到问题，浏览器中提供的标准Javascript库 . 具体来说，我在 HTMLImageElement 上设置 onload 回调函数，使用 new Image() 创建 . 我还想阅读 src 属性，因为它具有非标准行为 - 当分配此属性时，将重新加载图像 . Mozilla在这里有各种属性的骨架文档：... -
94 votesanswersviews
pinterest api文档[关闭]
Update Aug 2015: Pinterest现在在这里提供https://dev.pinterest.com/ Is there official or unofficial documentation on the v2 Pinterest API? 我知道的事情： JSON api在版本2中.https://api.pinterest.com/v2为您提供了json响应 人们... -
141 votesanswersviews
pandas resample文档[关闭]
所以我完全理解如何使用resample，但文档并没有很好地解释选项 . 所以 resample 函数中的大多数选项都很简单，除了这两个： rule：表示目标转换的偏移字符串或对象 how：string，down-or-sampling的方法，默认为'mean' 因此，通过查看我在网上找到的尽可能多的示例，我可以看到规则你可以做 'D' 一天， 'xMin' 做分钟， 'xL' 做毫秒，... -
91 votesanswersviews
在同一个包装上使用roxygen2和doxygen？ [关闭]
我有一个使用 roxygen2 的 R 包 . 它在 /src 中有一些 C 代码，我刚刚开始使用Doxygen . 有没有办法组合文档，或集成编译与roxygen2？任何"best practices"用于放置 C 代码文档的位置？ 谷歌搜索roxygen2和doxygen主要导致 roxygen is similar to doxygen 结果 . 我找到了一些包含Doxy...