documentation相关内容

如何使用Doxygen记录Python代码

我喜欢Doxygen创建C或PHP代码的文档。我有一个即将到来的Python项目，我想我还记得Python没有 / * .. * / 注释，并且也有自己的自我文档工具， 由于我熟悉Doxygen，如何使用它来生成Python文档？ 解决方案 这是记录在doxygen网站上，但此处总结如下： 您可以使用doxygen来记录您的Python代码。您可以使用Python文档字符串语法 ..

发布时间：2020-10-25 05:51:55 python documentation python-sphinx doxygen docstring Python

如何在JSDoc中指定对象数组作为参数或返回值？

在JSDoc中，如果您具有特定类型的数组（例如字符串数组），则我可以找到的最佳文档显示使用以下内容： / ** * @param {Array。} myStrings我所有很棒的字符串 * / function blah（myStrings）{ //这里的东西... } 您将如何替换以下内容问号指定对象数组吗？ / ** * ..

发布时间：2020-10-25 05:51:51 javascript documentation jsdoc 前端开发

如何用参数记录方法？

如何使用Python的文档字符串来记录带有参数的方法？ 编辑： PEP 257 给出了以下示例： def复数（real = 0.0，imag = 0.0）： “”“形成复数。 关键字参数： real-实部（默认为0.0） imag-虚部（默认为0.0） “”“ 如果imag == 0.0并且real == 0.0：return complex_zero ... ..

发布时间：2020-10-25 05:51:47 python documentation documentation-generation Python

#Swift中的pragma标记？

在目标C中，我可以使用 #pragma mark 在符号导航器中标记代码的各个部分。由于这是C预处理程序命令，因此在Swift中不可用。在Swift中是否有替代方法？还是我必须使用丑陋的注释？ 解决方案 您可以使用 // MARK： 也有人在讨论自由使用无论如何，扩展类可能是更好的做法。由于扩展程序可以实现协议，因此您可以将所有表视图委托方法放在扩展中，并在 #pragma mark ..

发布时间：2020-10-25 05:51:44 swift documentation 移动开发

如何在DRF文档中描述参数

我正在使用Django REST Framework v3.6内置交互式文档 django_rest_framework.documentation （不 django -rest-swagger ）。 基本上，我正在关注官方文档，并在我的URLset配置中使用它： 从rest_framework.documentation导入include_docs_urls urlpatt ..

发布时间：2020-10-22 23:06:13 python django documentation django-rest-framework Python

什么是co_names？

说明，价格为 co_names 读取： 局部变量名称元组 但是实际上， co_names 是一个全局变量名的元组，而 co_varnames 是局部变量名称（和参数名称）的元组。例如： a = 1 def f（b）： c = a + b print（f .__ code __。co_varnames）＃打印（'b'，'c'） print（f .__ code ..

发布时间：2020-10-11 00:57:36 python documentation cpython Python

在快速帮助文档注释中添加到Swift类的链接？

假设我有两个类别： / ** 此类应与[Foo]一起使用（???）。 * / class Bar { func doNothing（）{} } / ** Foo所做的描述在这里。 * / 类Foo { func doNothing（）{} } 我想从Bar在Xcode中的快速帮助中创建到Foo或Foo的快速帮助的链接。可能吗？如果是这样 ..

发布时间：2020-10-06 05:03:07 swift xcode documentation comments 移动开发

在哪里记录C或C ++中的函数？

我有一个包含多个文件的C程序，所以我有例如实现某些功能的 stuff.c 和 stuff。 h 带有函数原型。 我应该如何在注释中记录函数？ 我应该在头文件中包含所有文档，还是在 .c 文件中包含所有文档，或者同时复制这两个文档？我喜欢后一种方法，但是随后遇到的问题是，我将在其中一个而不是另一个上更新文档（通常是我进行第一次修改的文档，即如果先修改头文件，然后修改其注释）会反映出来，但 ..

发布时间：2020-10-06 04:48:11 c documentation comments header-files 其他开发

有没有一种方法可以在Python中创建多行注释？

我最近开始研究 Python ，但是我找不到方法实施多行注释。大多数语言都有块注释符号，例如 / * * / 我在Python中尝试过此方法，但它会引发错误，因此这可能不是正确的方法。 Python实际上是否具有多行注释功能？ 解决方案 您可以使用三引号字符串。当它们不是文档字符串时（类/函数/模块中的第一件事），它们将被忽略。 '' ' 这是多行 ..

发布时间：2020-10-06 04:48:07 python comments documentation Python

使用CMake打开Doxygen文档的主页

我有一个使用Google测试的项目。我在根目录中有以下CMake文件： set（CMAKE_C_COMPILER gcc） cmake_minimum_required（版本3.10.2） FATAL_ERROR） 项目（PROJECT） 设置（CMAKE_INCLUDE_CURRENT_DIR ON） 设置（CMAKE_AUTOMOC ON） 设置（CMAKE_AUTOUIC ON ..

发布时间：2020-10-03 21:52:53 cmake documentation doxygen 其他开发

从类详细信息导出Visual Studio

我发现在Visual Studio中，我们可以通过创建类图，添加类和打开类详细信息来轻松地将摘要添加到代码中。 现在我想知道是否可以将其导出到excel文件中。 解决方案 从@MD对此答案 https://stackoverflow.com/a/39080107/382515 （ Visual Studio转到“分析”菜单->“计算解决方案的代码度量标准”，然后在显示的面板上单 ..

发布时间：2020-10-02 02:54:23 c# visual-studio documentation class-diagram C#/.NET

使用Google Closure编译器记录回调参数

如何使用Google Closure编译器记录回调参数的名称和说明？ 阅读关于使用JSDoc记录回调的答案，我尝试使用 @callback 和 @typedef 和 @name 标记，但每个标记都遇到了问题。 使用 @callback ，闭包给出“非法使用未知的JSDoc标签”警告： / ** * @callback EndDrawCallback * @param { ..

发布时间：2020-09-29 00:28:43 javascript callback documentation google-closure-compiler jsdoc 前端开发

是否存在用于记录或说明(Docker)容器在系统体系结构规范中的作用的公认的UML图表样式?

我打算绘制一些UML结构图，以说明Docker映像(或容器，在部署图中)在我正在构建的软件的总体结构中的位置. 我有兴趣说明容器的内容，网络端口和其他接口的映射以及多个容器的互操作方式. 我的问题空间是基于事件的分布式系统(DEBS)，所以我希望我的大多数容器都会有进出消息队列.我的体系结构的另一部分涉及内存数据网格的使用，该网格将跨越集群中多个节点上的许多容器. 如何用UML建模?如 ..

发布时间：2020-09-06 19:37:48 docker architecture uml documentation distributed-computing 其他开发

如何共享Swagger文档

我最近开始将Swagger用于我的文档，但是对我来说仍然有些事情还不清楚.我创建了YAML文档，现在我希望能够与团队其他成员共享.pdf或HTML/Javascript页面中的文档.我不能使用SwaggerHub，因为它们没有私有存储库，并且Swagger Editor似乎不允许共享右侧的面板. 请明确一点，我希望能够得到类似的东西: 我想念什么? 解决方案 DynamicAp ..

发布时间：2020-09-05 20:45:44 javascript api rest documentation swagger 前端开发

如何解释API文档功能参数?

API文档中是否存在解释功能接口语法的标准，如果有，它是如何定义的? 以下是有关如何更改项目颜色的示例，这是Photoshop的JavaScript脚本指南中针对"fillColor"功能进行的更改: fillPath ([fillColor] [, mode] [, opacity] [, preserveTransparency] [, feather] [, wholePath] ..

发布时间：2020-09-05 18:59:24 api documentation 其他开发

如何理解Spark中的reduceByKey?

我正在尝试学习Spark，到目前为止进展顺利，除了需要在一对RDD(其值为列表)上使用reduceByKey或CombineByKey之类的功能的问题之外. 我一直在尝试找到这些功能的详细文档，这些文档可以解释参数的实际含义，以便我自己解决问题而无需进行Stack Overflow，但我只是找不到关于Spark的任何好的文档.我已经阅读了Learning Spark的第3章和第4章，但是老实 ..

发布时间：2020-09-04 07:45:24 python apache-spark functional-programming pyspark documentation Python

如何为Android开发者网站设置语言?

当我尝试导航到Android开发者网站时，我被重定向到其中的大部分中文版本.例如，如果我尝试导航到: developer.android.com 我被重定向到: http://developer.android.com/intl/zh-cn/index.html 我想要英语网站.在某些情况下，我不得不将网页翻译成中文.我究竟做错了什么?如何抑制这种行为? 解决方案 虽然 ..

发布时间：2020-08-30 07:37:16 android documentation 移动开发

Android Studio中没有参考文档

昨天刚弹出一个新问题.当我将鼠标悬停在某个方法上或按Ctrl-Q时，我通常会获取该特定方法的文档信息. 但是现在我得到了(在SharedPreferences.getLong()上按Ctrl-Q): Following external urls were checked: http://developer.android.com/reference/andro ..

发布时间：2020-08-29 00:59:46 java android-studio editor documentation Java开发

Xcode 8.2.1在自动完成功能上未显示文档描述

我在向Xcode 8.2.1中的代码添加文档时遇到问题. 这是我的代码: /// Test documentation method /// /// - Parameter string: The input string /// - Returns: The output bool func testMethod(string:String) -> Bool { if st ..

发布时间：2020-07-31 07:25:15 swift xcode autocomplete swift3 documentation 移动开发

如何将Rust模块文档保存在单独的Markdown文件中?

Rust的本部分本书似乎暗示可以将Rust文档保存在单独的.md文件中，但是并未说明如何将这些.md文件包含回去.如何运作? 解决方案 不是.描述rustdoc功能的那部分说，它可以处理单个.md文件.第三段涉及到这一点: 可以通过两种方式生成文档:从源代码和独立的Markdown文件. 据我所知，目前尚无将代码文档放入外部文件的方法.从理论上讲，可以使用过程派生宏来执行此操作 ..

发布时间：2020-07-31 05:39:46 rust documentation rustdoc 其他开发