Questions tagged «documentation»

已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗？更新问题，以便通过编辑此帖子以事实和引用的形式回答。 2年前关闭。 改善这个问题 是否有自动的方法在界面及其实现之间同步注释？我目前正在记录它们，并且不想手动保持它们同步。 更新： 考虑以下代码： interface IFoo{ /// <summary> /// Commenting DoThis method /// </summary> void DoThis(); } class Foo : IFoo { public void DoThis(); } 当我创建这样的类时： IFoo foo=new Foo(); foo.DoThis();//comments are shown in intellisense 这里的注释未显示： Foo foo=new Foo(); foo.DoThis();//comments are not shown in intellisense 的 <inheritDoc/>标签将完美地在Sand …

98 c#  documentation  xml-documentation 

已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗？更新问题，以便通过编辑此帖子以事实和引用的形式回答。 2年前关闭。 改善这个问题 常识告诉我们，Doxygen注释块必须放在类，结构，枚举，函数，声明所在的头文件中。我同意这是一个合理的论据，对于没有源的库（仅包含目标代码的标头和库）来说，这是合理的。 但是...在开发公司内部（或作为我自己的副项目）库时，我一直在想完全相反的方法，该库将与其完整的源代码一起使用。我建议将大注释块放在实现文件（HPP，INL，CPP等）中，以免使标头中声明的类和函数的界面混乱。 优点： 头文件中的混乱程度较小，只能添加功能分类。 例如，使用Intellisense时预览的注释块不会冲突-这是我在.H文件中具有函数的注释块并在同一.H文件中具有内联定义时观察到的缺陷。但包含在.INL文件中。 缺点： （显而易见的一个）注释块不在声明所在的头文件中。 那么，您如何看待并可能提出建议？

97 documentation  comments  doxygen 

我正在尝试在Python中进行一些类继承。我希望每个类和继承的类都具有良好的文档字符串。因此，我认为对于继承的类，我希望这样做： 继承基类文档字符串 也许将相关的额外文档附加到文档字符串中 在类继承情况下，是否有任何（可能是优雅的或pythonic的）方式来进行这种文档字符串操作？多重继承怎么样？

97 python  inheritance  documentation 

关闭。此问题不符合堆栈溢出准则。它当前不接受答案。 想改善这个问题吗？更新问题，使其成为Stack Overflow 的主题。 4年前关闭。 改善这个问题 2015年8月更新： Pinterest现在在这里提供它https://dev.pinterest.com/ v2 Pinterest API是否有官方或非官方文档？ 我知道的事情： JSON API在版本2中 。https ://api.pinterest.com/v2为您提供JSON响应 人们正在反对它，因为有一个移动应用程序和beta开发人员 关于SO的Pintrest身份验证问题 Kellan在Github上针对v1进行PHP包装，并针对v2进行了更新，其方法包括：上载，固定，重载，面板，活动，流行-阅读Kellan的代码是我能找到的最佳信息 来自Pinterest小组的回复，详细介绍了Kellan的作品 私人非官方Facebook Pinterest开发小组 以下是Pinterest背后的一些明星 更新2014年3月4日 Pinterest推出了Beta v3 API，您可以请求对其进行访问。向下滚动页面，您将在左列中看到端点。 https://developers.pinterest.com/api_docs/ 2013 年1月9日更新由于https://api.pinterest.com/v2提供了404，因此它似乎已移至v3。 https://api.pinterest.com/v3 { "status": "failure", "code": 11, "host": "053", "generated_at": "Wed, 09 Jan 2013 10:25:27 +0000", "message": "API method not found.", …

96 json  api  mobile  documentation  pinterest 

使用JavaDoc，如何在类中引用最终静态字段的值？ 我希望???在此示例中将其替换为field的值STATIC_FIELD。 /** * This is a simple class with only one static field with the value ???. */ public class Simple { /** * We can reference the value with {@value} here, * but how do we reference it in the class JavaDoc? */ public static final String STATIC_FIELD …

96 java  documentation  javadoc 

已关闭。这个问题需要更加集中。它当前不接受答案。 想改善这个问题吗？更新问题，使其仅通过编辑此帖子来关注一个问题。 2年前关闭。 改善这个问题 我喜欢Doxygen创建C或PHP代码的文档。我有一个即将到来的Python项目，我想我还记得Python没有/* .. */评论，也有自己的自我文档编制功能，这似乎是Python的记录方式。 既然我熟悉Doxygen，如何使用它来生成我的Python文档？有什么特别需要我注意的吗？

94 python  documentation  doxygen  docstring  python-sphinx 

已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗？更新问题，以便通过编辑此帖子以事实和引用的形式回答。 2年前关闭。 改善这个问题 我有一个R使用的软件包roxygen2。它在中有一些C代码/src，而我刚开始使用Doxygen。有什么方法可以合并文档或将编译器与roxygen2集成在一起？在哪里放置C代码文档有“最佳实践” 吗？ 对roxygen2和doxygen进行谷歌搜索主要导致roxygen与doxygen结果相似。我发现了一些带有Doxyfiles的软件包，但是没有一致的组织。例如，lme4已inst/doc/Doxyfile输出到源目录doxygen外部的文件夹lme4。Matrix的根目录中也有一个Doxyfile（但在以前的版本中是inst。该文档也被导出到package目录之外。 是否有任何理由不将C文档包含在软件包中，或者尽管Doxygen广泛使用，为什么Doxygen在R软件包中却很少使用C？ 更新：请参阅相关的roxygen2功能请求

91 c  r  documentation  doxygen  roxygen2 

关闭。此问题不符合堆栈溢出准则。它当前不接受答案。 想改善这个问题吗？更新问题，使其成为Stack Overflow的主题。 2年前关闭。 改善这个问题 我是Pandas的新手，正在尝试使用date_range。我遇到了各种各样的美好事物freq，例如BME和BMS而且我希望能够快速查找适当的字符串以得到我想要的东西。昨天我在文档中的某个地方找到了一个格式良好的表，但是该表的标题太钝了，以至于我今天无法使用搜索再次找到它。

91 python  pandas  documentation  dataframe  frequency 

按照目前的情况，这个问题不适合我们的问答形式。我们希望答案会得到事实，参考或专业知识的支持，但是这个问题可能会引起辩论，争论，民意测验或进一步的讨论。如果您认为此问题可以解决并且可以重新提出，请访问帮助中心以获取指导。 8年前关闭。 请确定最流行的轻量标记语言，并比较它们的优缺点。这些语言应该是技术散文（例如文档）的通用标记（例如，Haml不计算在内）。 另请参阅：Markdown与ReStructuredText

90 documentation  markdown  markup  restructuredtext  textile 

假设，在记录代码（Javadoc）的过程中，您希望使用深度缩进来指示元素之间的关系。 如何创建嵌套列表为： 一些要素 其他要素 还有其他一些要素

86 documentation  javadoc  indentation  nested-lists 

从目前的情况来看，这个问题不适合我们的问答形式。我们希望答案能得到事实，参考或专业知识的支持，但是这个问题可能会引起辩论，争论，民意调查或扩展讨论。如果您认为此问题可以解决并且可以重新提出，请访问帮助中心以获取指导。 7年前关闭。 我找不到适用于Android的离线文档。有人可以提供链接吗？

83 android  documentation  offline 

我有一些代码返回一个Promise对象，例如使用Q库的NodeJS。 var Q = require('q'); /** * @returns ??? */ function task(err) { return err? Q.reject(new Error('Some error')) : Q.resolve('Some result'); } 如何使用JSDoc记录这样的返回值？

83 javascript  node.js  documentation  jsdoc  promise 

在用记事本++和sublime进行了许多快乐的编码之后，建议我尝试使用PHP IDE。我正在尝试phpStorm，看起来不错。代码完成和文档是一个很棒的功能，但是当使用魔术方法时，对我来说却行不通。是否有解决方法使phpStorm了解魔术方法的状况？ 我们的情况是这样的： abstract class a { public static function __callStatic($method,$args) { if(strpos($method,"get_by_") === 0) { //do stuff } elseif(strpos($method,"get_first_by_") === 0) { //do stuff } elseif($method == "get_all") { //do stuff } } } class b extends a { // some more stuff } b::get_by_user_id(27); b::get_first_by_id(156); b::get_all(); 神奇的callStatic方法使我们能够通过1个或多个组成函数调用的参数来获取对象的集合。 我看到在这些情况下有一个@method语句可以使用，但是phpStorm仅选择了这些语句中的第一个。此外，我只能将返回类型设置为“ …

80 php  documentation  phpstorm  magic-methods  docblocks 

关闭。此问题不符合堆栈溢出准则。它当前不接受答案。 想改善这个问题吗？更新问题，使其成为Stack Overflow的主题。 6年前关闭。 改善这个问题 让我们面对现实：您无需成为设计师即可看到默认的Javadoc看上去很丑陋。 网络上有一些资源提供了重新样式化的Javadoc。但是默认行为代表了产品，并且应该看起来相当合理。 另一个问题是，与其他类似资源相比，Javadoc的可用性不是最新的。 大型项目很难使用Firefox的快速搜索进行导航。 实际问题： 是否有任何独立（桌面）应用程序能够以比浏览器更有用的方式浏览现有Javadoc？ 我正在考虑诸如Mono文档浏览器之类的东西。 理论上的问题： 是否有人知道，如果有计划以某种标准化的方式发展Javadoc？ 编辑： 有关此主题的Sun Wiki的有用链接。

80 java  documentation  javadoc 

关闭。此问题不符合堆栈溢出准则。它当前不接受答案。 想改善这个问题吗？更新问题，使其成为Stack Overflow的主题。 2年前关闭。 改善这个问题 这是一个非常简单的问题，但是我还没有在Google上找到任何东西。我正在寻找有关Node.js的创建服务器功能中的request参数的文档，但是我什么都找不到。 http.createServer(function(request, response){ console.log(JSON.stringify(request)); }); 使用JSON.stringify（）进行调试会给我一个错误，该对象是圆形的并且程序停止了。我看到过类似request.url，或的不同内容request.body，但是是否有一个页面记录了所有请求功能和参数？似乎应该很容易找到它，但我似乎找不到。 我再次尝试，结果发现只是console.log(request)从请求中写出了所有数据。这里只是作为参考： ondata: [Function], _httpMessage: { domain: null, _events: [Object], _maxListeners: 10, output: [], outputEncodings: [], writable: true, _last: false, chunkedEncoding: false, shouldKeepAlive: true, useChunkedEncodingByDefault: true, sendDate: true, _hasBody: true, _trailer: '', finished: false, _hangupClose: false, socket: [Circular], connection: [Circular] …

80 node.js  documentation  request