documentation相关内容

如何记录函数的全局依赖关系?

我从第三方供应商那里获得了一些C代码(用于嵌入式平台)，该代码使用了全局变量(用于速度和空间优化).我正在记录代码，转换为 Doxygen 格式. 如何在函数文档中为函数需要的有关全局变量和函数的注释? Doxygen 具有用于注释参数和返回值的特殊命令，如下所述: ..

发布时间：2021-05-02 20:02:51 c documentation global-variables doxygen 其他开发

GoDoc添加换行符

我知道Golang通过以功能名称(拼写为"func")开头的单行注释来支持功能文档.但是，有一个令人作呕的副作用:具有多个单行注释将不会产生带有换行符的GoDoc，而换行符将文本的每一行分隔开 下面是一张图片来说明: 如何在生成的文档中插入换行符?(如果这是Javadoc，我会很喜欢 ，那么一切都会很好) 解决方案 插入一个空的注释行，它将是一个新段落，这意味着它将在 ..

发布时间：2021-05-02 20:02:46 go documentation godoc 其他开发

TypeDoc抱怨“找不到模块"

我有一个基于Typsecript的react应用程序.它工作正常，但我想将TypeDoc(对于Typescript认为是JSDoc)添加到混合中.安装后，我从命令行运行它(仅在测试时处理单个文件): typedoc --module commonjs --jsx react --out ../docs/./src/components/404/404.tsx 我得到一个错误: 错误:/p ..

发布时间：2021-05-02 20:02:43 reactjs typescript documentation typedoc 其他开发

Vuetify离线文档

我已经开始使用Vuetify添加ui组件并使用预定义的布局.问题是我必须不时查看在线文档，并要求我永久连接到互联网. 有没有办法获取Vuetify的离线文档?像使用doxygen/javadocs生成的html还是CHM?PDF?乳胶?真的有什么帮助. 解决方案 更新 git clone https://github.com/vuetifyjs/vuetifyjs.com.gi ..

发布时间：2021-05-02 20:02:40 vue.js documentation offline vuetify.js offline-browsing 前端开发

XML/XSD-添加描述

使用XSD可以确保XML文件有效，但是还有一种方法可以使用XSD将信息附加到元素和属性，以便打开XML和XSD文件的软件可以显示当用户单击所描述的元素时向用户显示该描述? 解决方案 您正在描述 xsd:documentation 元素. xsd:documentation 和 xsd:appinfo 都可以包含在 xsd:annotation 元素中: 使用 xsd:docum ..

发布时间：2021-05-02 20:02:37 xml xsd documentation editor 其他开发

模块中的Sphinx autodoc功能

我刚开始使用狮身人面像并愿意学习. 我想将我的各种功能分解为 index.rst 文件中的不同部分.因此，每个函数都有其自己的标头. 例如，如果我有一个名为 test.py 的python文件，并且在该文件中，我有2个函数: def foo():“"“此打印栏"“"打印(“栏")def bar():“"“这将打印foo"“"print("foo") 我如何在 index.rst ..

发布时间：2021-05-02 20:02:34 python documentation python-sphinx docstring autodoc Python

VS2012如何通过IntelliSense显示标准C ++库的文档?

几天前，我开始使用Visual Studio 2012学习C ++.我习惯于使用IntelliJ IDEA对Java进行编程，并且在调用方法时，总会向您展示文档和预期的参数.在VS2012 for C ++中有没有办法做到这一点? 如果我正确理解它，由于IntelliSense，应该已经显示了它，但是例如，如果我调用向量或字符串的成员函数，它只会显示出类似以下内容: public:st ..

发布时间：2021-05-02 20:02:31 c++ visual-studio-2012 documentation intellisense C/C++开发

氧分组

我对氧气中的页面和组有疑问.我有一个项目，在这里我将类等与@defgroup和@ingroup cmds分组.到目前为止，一切正常. 现在，我想为带有降价页面的项目添加特殊文档.这些页面应显示在专用模块(组)中.我尝试使用@page和@subpage cmds创建页面.效果很好，但是页面在菜单中显示为纯白. 因此，我尝试使用@ingroup将它们添加到组中.但这不起作用，正如我猜到的那 ..

发布时间：2021-05-02 20:02:28 documentation doxygen 其他开发

内部函数(python)的文档字符串是否必要?

在python中，我们在内部函数/私有方法的开头加了下划线.这些功能是否应该使用docstrings记录下来(是否需要?)?(我的意思是正式文档，而不是帮助代码阅读器理解代码的文档).这是常见的做法? 解决方案 Lo，我引用了 PEP 8 ，其明智之词应视为法律.关于这个话题，PEP 8说: 为所有公共模块，函数，类和方法.对于非公共方法，文档字符串不是必需的，但是您可以应该有描述该 ..

发布时间：2021-05-02 20:02:24 python documentation standards pep8 Python

有一种明智的方法来在R中执行类似文档字符串的操作吗?

这不仅仅是编码风格的问题.如果您了解python(我也认为Ruby也有类似的东西)，则您可以在函数中使用docstring，以便您可以通过发出"help"命令轻松获得该字符串.例如: def something(t =无):'''做点事，也许是为了t:一件事您可能不想这样做'''如果t不为None:返回t ** 2别的:返回“或者也许不" 然后 help(something)返回以下内容: ..

发布时间：2021-05-02 20:02:21 r documentation 其他开发

如何添加我自己的“帮助"信息到python函数/类?

我知道我可以使用"help()"来查看软件包中的现有帮助信息.但是，在编写了自己的函数/类之后，如何启用“帮助"以查看帮助文档?我知道“评论"的第一行是 doc 属性，但这不是我想要的. 我希望自己编译一个软件包，其他人可以从"help()"中看到.该怎么做? 解决方案 help()完全基于 __ doc __ 属性(以及函数参数的自省)，因此确保您的模块，类和函数都具有文档字符串. ..

发布时间：2021-05-02 20:02:18 python documentation Python

我对Object.entries()感到困惑

我已经检查了此页面: mozilla文档 我不明白为什么索引0为: const object3 = {100:'a'，2:'b'，7:'c'};console.log(Object.entries(object3)[0]);//预期的输出:数组["100"，"a"] ..

发布时间：2021-05-02 20:02:15 javascript object documentation 前端开发

使用roxygen2在单个文档对象中记录多个数据集

我正在寻找一个等效的 @describeIn ，它将允许我为多个R数据对象创建一个文档对象. 我希望是这样的: #'树距离#'#'这些数据集包含集合之间的距离10针，11针和12针树的数量.#'#'@name treeDistances#'@keywords数据集"treeDistances10""treeDistances11""treeDistances12" 将产生一个适用于所有 ..

发布时间：2021-04-29 18:46:06 r dataset documentation documentation-generation roxygen2 其他开发

SQL开发人员:为其他用户生成数据库文档

我的数据库中有一个Admin用户.管理员用户有权访问所有数据库对象.我没有管理员用户的凭据. 我的应用程序还具有普通用户，该用户具有对Admin用户的许多对象的访问权限(选择/删除授予等).因此，在SQL Developer中，当我使用普通用户创建连接时，可以转到“其他用户->管理员用户"，然后会看到许多表/视图/触发器/过程. 当我尝试使用SQL Developer生成数据库文档时( ..

发布时间：2021-04-28 19:52:34 database oracle documentation oracle-sqldeveloper 数据库

Flutter和Dart文档中的@macro注释是什么

在阅读源代码时，我经常会看到类似的内容(来自 ..

发布时间：2021-04-28 18:56:15 flutter dart documentation 其他开发

google docs电子表格导出:如何从时间，日期中删除撇号

我正在从Google文档中将电子表格导出为CSV，并且每个日期和时间值前面都带有撇号(').这真的很烦人，因为OpenOffice似乎无法在电子表格编辑器中查找/替换这些内容. 我可以通过将CSV文件作为文本打开并用这种方式替换字符来解决此问题，但是似乎必须首先有一种方法来防止出现此问题.有人知道解决此问题的方法吗?(在OO文件导入期间删除它们也是一种可以接受的解决方案.) 解决方案 ..

发布时间：2021-04-27 19:56:21 csv documentation openoffice.org openoffice-calc 其他开发

我如何在Common Lisp中访问Defclass插槽的:Documentation字符串

好的，这是我如何实例化我的Defclass以及相关的Defmethod和Defparameter (defvar *帐户号* 0)(defclass银行帐户()((顾客姓名:initarg:客户名称:initform(错误“必须提供客户名称."):访问者客户名称:文档“客户名称")(平衡:initarg:平衡:initform 0:读者余额:文档“当前帐户余额")(账号:initform(inc ..

发布时间：2021-04-23 19:42:08 class documentation common-lisp 其他开发

PHP如何用于解析主题和插件的注释/标头?

WordPress插件和主题的顶部注释如下: /*** @包装Akismet*//*插件名称:Akismet插件URI:http://akismet.com/?return=true描述:Akismet已被数百万人使用，可能是全世界保护您的博客免于评论和引用垃圾邮件//strong的最佳方法.即使您在睡觉时，也可以使您的网站免受垃圾邮件的侵扰.要开始使用，请:1)单击此描述左侧 ..

发布时间：2021-04-23 19:38:14 php wordpress parsing documentation comments PHP

记录CMake模块的正确方法是什么?

快速的Google搜索(实际上实际上是许多相当广泛的Google搜索)无法解释如何正确记录CMake模块. 我正在寻找一种记录自定义CMake模块的方法，以便它们与 cmake --help-module 命令一起使用.有什么标准的方法可以做到这一点吗?谁能给我指出一些很好的例子?记录过程似乎很奇怪....记录不充分.哈哈. 如何记录与 cmake --he ..

发布时间：2021-04-22 19:48:06 cmake documentation cmake-modules 其他开发

如何基于功能标志有条件地执行模块级doctest?

我正在编写一个模块的文档，该模块具有一些由Cargo功能标记控制的选项.我希望始终显示此文档，以便板条箱的使用者知道它可用，但是我只需要在启用该功能时运行该示例. lib.rs //！此板条箱具有常用的功能//！//！```//！assert_eq！(2，Featureful :: add_one(1));//！```//！//！您可能还想使用功能标记`solve_halting_prob ..

发布时间：2021-04-12 20:31:54 rust automated-tests documentation conditional-compilation 其他开发