Questions tagged «documentation»

我最近开始研究Python，但是找不到如何实现多行注释。大多数语言都有块注释符号，例如 /* */ 我在Python中尝试过此方法，但它引发了错误，因此这可能不是正确的方法。Python实际上是否具有多行注释功能？

1156 python  comments  documentation 

在目标C中，我可以使用#pragma mark符号导航器标记代码的各个部分。由于这是C预处理程序命令，因此在Swift中不可用。在Swift中有替代方法吗？还是我必须使用丑陋的注释？

936 swift  documentation 

已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗？更新问题，以便通过编辑此帖子以事实和引用的形式回答。 2年前关闭。 我已经看到了几种用Python编写文档字符串的样式，是否有正式或“同意的”样式？

887 python  coding-style  documentation  docstring 

按照目前的情况，这个问题不适合我们的问答形式。我们希望答案会得到事实，参考或专业知识的支持，但是这个问题可能会引起辩论，争论，民意测验或进一步的讨论。如果您认为此问题可以解决并且可以重新提出，请访问帮助中心以获取指导。 7年前关闭。 我有一个同事坚持认为他的代码不需要注释，而是“自我记录”。 我已经阅读了他的代码，尽管它比我看到的其他代码更清晰，但我仍然不同意自我记录代码与注释和记录代码一样完整和有用。 帮我理解他的观点。 什么是自我记录代码 它真的可以代替经过良好注释和记录的代码吗？ 在某些情况下，它比记录和注释好的代码更好吗？ 是否有一些示例，其中如果没有注释，代码可能无法自我记录 也许这只是我自己的局限性，但我不认为这是一种好的做法。 这并不意味着要争论-请不要提出充分注释和记录的代码具有较高优先级的原因-有很多资源可以证明这一点，但它们并不能说服我的同事。我相信我需要更充分地了解他的观点，才能说服他。如有必要，请提出一个新问题，但不要在这里争论。 哇，反应快！请阅读所有现有答案，并为答案提供评论，而不要添加新答案，除非您的答案与此处的其他答案确实有很大不同。 另外，你们中那些反对自我记录代码的人-这主要是为了帮助我理解自我记录代码传播者的观点（即积极方面）。如果您不关注主题，我希望其他人会投票反对您。

258 documentation  comments 

关闭。此问题不符合堆栈溢出准则。它当前不接受答案。 想改善这个问题吗？更新问题，使它成为Stack Overflow 的主题。 2年前关闭。 改善这个问题 一个Xcode中5的新功能是一种特殊的注释语法来记录自己的代码的能力。格式类似于doxygen，但似乎仅支持这些功能的子集。 支持哪些命令，不支持哪些命令？ 它们的用法是否与doxygen不同？

186 objective-c  documentation  comments  doxygen  xcode5 

因此，我完全理解如何使用resample，但是文档在解释这些选项方面做得不好。 因此，resample除了以下两个以外，函数中的大多数选项都非常简单： rule：表示目标转换的偏移量字符串或对象 方式：字符串，下采样或重新采样的方法，默认为“均值” 因此，通过查看我在网上找到的尽可能多的示例，我可以看到规则可以'D'在一天，'xMin'几分钟，'xL'几毫秒内完成，但这就是我所能找到的全部。 如何我看到的情况如下：'first'，np.max，'last'，'mean'，和'n1n2n3n4...nx'其中nx为每列索引的第一个字母。 因此，我在文档中缺少的某个地方显示了pandas.resample规则的每个选项以及如何输入？如果是，在哪里，因为我找不到它。如果没有，那么他们有什么选择？

184 python  documentation  pandas 

已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗？更新问题，以便通过编辑此帖子以事实和引用的形式回答。 2年前关闭。 改善这个问题 好的，我已经阅读了PEP 8和PEP 257，并且为函数和类编写了许多文档字符串，但是我不确定模块文档字符串中应该包含什么。我认为，至少它应该记录该模块导出的功能和类，但是我也看到了一些列出作者姓名，版权信息等的模块。有没有人举过一个很好的python docstring应该怎么做的例子。有条理？

167 python  documentation  module 

已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗？更新问题，以便通过编辑此帖子以事实和引用的形式回答。 2年前关闭。 改善这个问题 我目前从Python开始，我有很强的PHP背景，在PHP中，我习惯于javadoc用作文档模板。 我想知道它是否在Python文档中javadoc占有一席之地docstring。这里有哪些既定的公约和/或官方指南？ 例如，类似这样的内容太复杂，无法适应Python的思维方式，还是我应该尽量简洁一些？ """ replaces template place holder with values @param string timestamp formatted date to display @param string priority priority number @param string priority_name priority name @param string message message to display @return string formatted string """ 而且，如果我有点过于详尽，我应该改用类似的东西（大多数文档都无法通过该__doc__方法打印）吗？ # replaces template place holder with values …

162 python  documentation  javadoc  docstring 

我目前正在编写一个小型框架，供公司内其他开发人员在内部使用。 我想提供良好的Intellisense信息，但是我不确定如何记录抛出的异常。 在以下示例中： public void MyMethod1() { MyMethod2(); // also may throw InvalidOperationException } public void MyMethod2() { System.IO.File.Open(somepath...); // this may throw FileNotFoundException // also may throw DivideByZeroException } 我知道记录异常的标记是： /// <exception cref="SomeException">when things go wrong.</exception> 我不明白的是如何记录by 调用的 代码引发的异常MyMethod1()？ 我应该记录由抛出的异常吗 MyMethod2() 我应该记录抛出的异常File.Open()吗？ 记录可能的例外的最佳方法是什么？

139 c#  .net  documentation  intellisense 

如何使用Python的文档字符串来记录带有参数的方法？ 编辑： PEP 257给出了这个例子： def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0) """ if imag == 0.0 and real == 0.0: return complex_zero ... 这是大多数Python开发人员使用的约定吗？ Keyword arguments: <parameter name> -- Definition (default value if any) …

139 python  documentation  documentation-generation 

关闭。此问题不符合堆栈溢出准则。它当前不接受答案。 想改善这个问题吗？更新问题，使其成为Stack Overflow 的主题。 12个月前关闭。 改善这个问题 我正在尝试查找使用FFmpeg C API的文档。似乎只有命令行文档可用。 有没有好的文档/教程/链接？

119 c  api  documentation  ffmpeg 

已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗？更新问题，以便通过编辑此帖子以事实和引文回答。 6年前关闭。 改善这个问题 TeX / LaTeX很棒，我以多种方式使用它。它的一些优点是： 它使用文本文件，因此可以区分输入文件，并且存在许多处理文本的工具 它非常灵活 它具有稳定的布局：如果我在文档开始处进行了更改，则不会影响文档末尾的其他内容 它具有许多扩展来实现不同的目标（后继者可以没有扩展就可以开始，但是会有一个很好的扩展系统） 您可以使用标准的构建控制工具来支持复杂的文档（感谢dmckee） 您可以封装解决方案，然后将其复制并粘贴到新文档中，或将其发送给其他人以供参考（感谢dmckee） 但另一方面，有些小事情却不太好： 一开始很难学习 控制图像的位置很复杂 有些事情有点违反直觉 有时您必须输入太多（开始{itemize} ... \ end {itemize}） 因此，是否存在LaTeX的后继者/替代品，或者至少是一些替代品的热门选择。一个真正的后继者/好的选择将保留优点，并消除缺点，或者至少消除其中的一些缺点。

118 documentation  latex  tex 

已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗？更新问题，以便通过编辑此帖子以事实和引用的形式回答。 2年前关闭。 改善这个问题 我正在编写一个轻量级的类，其属性旨在可公开访问，并且有时仅在特定的实例中被覆盖。就此而言，Python语言中没有为类属性或任何类型的属性创建文档字符串的规定。记录这些属性的预期方式和受支持方式是什么？目前，我正在做这种事情： class Albatross(object): """A bird with a flight speed exceeding that of an unladen swallow. Attributes: """ flight_speed = 691 __doc__ += """ flight_speed (691) The maximum speed that such a bird can attain. """ nesting_grounds = "Raymond Luxury-Yacht" __doc__ += """ nesting_grounds ("Raymond Luxury-Yacht") The …

115 python  class  documentation  docstring  class-attributes 

在JSDoc中，如果您具有特定类型的数组（例如字符串数组），则我可以找到的最佳文档显示使用以下内容： /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } 您将如何替换以下问号来指定对象数组？ /** * @param {???????} myObjects All of my equally awesome objects */ function blah(myObjects){ //stuff here... }

105 javascript  documentation  jsdoc 

API文档中是否存在解释功能接口语法的标准，如果是，则如何定义？ 这是有关如何为Photoshop的JavaScript脚本指南针对“ fillColor”功能更改项目颜色的示例： fillPath ([fillColor] [, mode] [, opacity] [, preserveTransparency] [, feather] [, wholePath] [, antiAlias]) 括号的含义是什么，为什么括号中有逗号？这与以下示例调用有何关系？ myPath.fillPath(myNewColor) myPath.fillPath(mynewColor, { mode: RGB, opacity: .5 })

103 api  documentation