documentation相关内容

Selenium Webdriver for NodeJS的文档在哪里?

我似乎找不到任何东西，我一直唯一找到的就是这个: https://code.google.com/p/selenium/wiki/WebDriverJs 但这更是一个指南.并非所有功能的文档.它缺少例如Webdriver.Window或getWindowHandles() 之类的文档. 解决方案 我总是需要重新查找它，所以我不妨在这里捕获它 http://seleniumhq.g ..
发布时间：2020-07-27 22:27:23 其他开发

如何在C#中的类，方法，属性等中添加文档工具提示?

不确定我是否称其为正确方法，但我想开始向我的类，方法，属性等添加一些文档.我知道这可能非常明显，但我从未真正学过它.我不确定从哪里开始. 只要澄清一下，当您将鼠标悬停在类(或方法，属性等)上时，它就会在Visual Studio中显示工具提示，并提供有关该特定方法的一些文档. Microsoft.Phone.BackgroundAudio.BackgroundAudioPlayer类 ..
发布时间：2020-07-27 04:22:55 C#/.NET

创建C#代码的HTML文档

我目前正在从事C#项目，VisualAssist为我生成了这些精美的/// 注释，并且我一直在使用它们来记录我的代码. 我假设必须有一种使用这些注释来创建HTML文档的方法，就像Doxygen或Javadoc所做的那样.我该怎么办? 解决方案 Doxygen 或请注意，您可以将这些文档导出器与文档生成器结合使用-如您所见，Resharper有一些 ..
发布时间：2020-07-26 21:39:07 C#/.NET

那是in或in/out参数吗? Doxygen，C ++

如果将指针传递给函数以进行只读，则该指针是一个IN参数. 如果将指针传递给某个函数以进行只读操作，但是此函数在该模块相关的函数中进行只读操作时可以访问该指针的副本，则该指针仍为IN. 如果该函数仍将指针用作只读，但是其他与模块相关的函数将指针用于写操作，那么指针又是什么? 一个IN参数，但没有const?输入/输出参数? 我的意思示例: class SteeringWheel ..
发布时间：2020-07-23 07:07:38 其他开发

DRF YASG定制

我正在尝试使用yasg自定义我的api文档. 首先，我想确定我自己的部分的命名，以及本部分应包括哪些端点.似乎各节的命名是基于不属于最长公共前缀的第一个前缀，例如: 如果我们拥有api/v1/message和api/v1/test网址，则这些部分将被命名为message和test.我有办法确定此部分的自定义命名吗? 此外，每个部分的介绍都是空的，如何在此处添加文本? 最后但并非最 ..
发布时间：2020-07-21 20:28:22 其他开发

将XML注释移至单独的文件

我喜欢 XML注释.但是，在一切崩溃的情况下，每两行看起来像: [/// summary ...] public void CreateUser(string username, string password)[...] 将此乘以数十或数百种方法，结果折叠后的代码很难筛选. 我可以将这些注释移到单独的XML文件，并且让Visual Studio识别该关联，以便它们仍显示在Intelli ..
发布时间：2020-07-15 02:44:26 C#/.NET

隐藏从Sandcastle生成的文档中从Object继承的方法?

如何从Sandcastle生成的文档中隐藏从Object类继承的方法(例如Equals，Finalize，GetHashCode，GetType等).我有一个名为LicenseManager的类，它具有一个方法，并且Object继承的方法阻塞了显示. 我正在使用最新版本的Sandcastle + Sandcastle帮助文件生成器. http://cl.ly/3Y2p1C0m1a3f1 ..
发布时间：2020-07-06 05:21:29 C#/.NET

我应该如何记录继承的成员?

考虑到我有一个复杂的类结构，其中许多元素是从其他元素继承的.我可能在接口中定义了方法GetStuff(string stuffName, int count)，该方法由其他接口继承，然后由抽象类抽象地实现，然后在具体类中显式实现，等等. 在使用XML注释记录我的代码时，我该如何处理诸如GetStuff()之类的继承成员，这些注释将与Doxygen或Sandcastle之类的工具一起使用?仅在 ..
发布时间：2020-07-06 05:17:12 其他开发

rdoc，darkfish和:call-seq:标签

我正在用rdoc记录Ruby项目，并且发现了darkfish rdoc格式化程序.我真的很喜欢，但是:call-seq:标记不再起作用.而是将文字字符串:call-seq:放入文档中，然后将调用序列本身格式化为代码块.我不想只从代码中删除所有:call-seq:块，因为我的许多文档都需要引用:call-seq:块中给出的实例名称和参数名称.有没有其他人有这个问题?我该怎么办，有没有解决方法?我很确 ..
发布时间：2020-07-05 06:00:55 其他开发

如何生成rdoc样式的可折叠代码段?

我正在使用Doxygen为C ++项目创建内部文档.我让Doxygen包含了方法等的来源，但这使页面难以扫描.我希望它的行为像rdoc一样，并将源隐藏在默认情况下折叠的块中. 我以为HTML_DYNAMIC_SECTIONS可能会让我这样做，但是可惜，变更日志说该选项只影响图表. 也许我可以通过编辑LAYOUT_FILE来做到这一点? 无论如何，聪明的人，我如何强迫Doxygen ..
发布时间：2020-07-05 05:59:42 其他开发

如何使用Python数据类记录类的构造函数?

我有一些现有的Python 3.6代码，我想移至Python 3.7数据类.我有带有漂亮文档字符串文档的__init__方法，指定了构造函数采用的属性及其类型. 但是，如果我更改这些类以使用3.7中的新Python数据类，则构造函数是隐式的.在这种情况下，如何提供构造函数文档?我喜欢数据类的想法，但是如果我必须放弃明确的文档才能使用它们，那就不喜欢. 已编辑，以阐明我当前正在使用文档字 ..
发布时间：2020-07-04 23:13:12 Python

三重单引号和三重双引号的文档字符串有什么区别?

我只是想知道两种编写Python Docstrings(__doc__)的方式之间的区别: 三个单引号: ''' Comment goes here ''' 三个双引号: """ Comment goes here """ 以后生成文档时格式化文档字符串的方式是否存在细微差别? 解决方案 否.他们是一样的.唯一的区别是，第一个可以包含三个未转义的双引号的序列， ..
发布时间：2020-07-02 20:33:10 Python

jsdoc:多行描述@property

我正在使用jsdoc记录我的代码，到目前为止，到目前为止，我有类似以下的评论 ... * @property {string} mode - mode of display 'video' - display video or 'audio' - play only the audio. * @property... ，它出现在 之类的html文档中 | ... | ..
发布时间：2020-06-29 18:36:43 前端开发

如何记录鸭子类型?

我对文档感到肿，因为每当遇到复杂的鸭子类型时，我都需要某种方式来表示“这种鸭子类型"，但是却陷入了无休止的“您的功能需要此输入内容的循环"中，但没有记录下来"，然后记录下来.这样会导致文件膨胀，重复，如下所示: def Foo(arg): """ Args: arg: An object that supports X functionality, and Y f ..
发布时间：2020-06-12 19:34:31 Python

您如何记录未检查的异常？

约书亚·布洛赫（Joshua Bloch）在他的《有效的Java》中写道： ”使用Javadoc @throws标记来记录 a方法可能抛出的每个未经检查的异常，但不要使用throws关键字在方法声明中包含未经检查的 异常。“ 听起来确实合理，但如何查找出来，我的方法可以抛出什么未经检查的异常？ 让我们考虑以下类： 公共类FooClass { private MyC ..
发布时间：2020-06-10 23:09:22 Java开发