Questions tagged «docstring»

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

887 python  coding-style  documentation  docstring 

已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗？更新问题，以便通过编辑此帖子以事实和引用的形式回答。 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 

已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗？更新问题，以便通过编辑此帖子以事实和引用的形式回答。 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 

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

94 python  documentation  doxygen  docstring  python-sphinx 

是否可以通过简单的方式将文档字符串添加到namedtuple？ 我试过了 from collections import namedtuple Point = namedtuple("Point", ["x", "y"]) """ A point in 2D space """ # Yet another test """ A(nother) point in 2D space """ Point2 = namedtuple("Point2", ["x", "y"]) print Point.__doc__ # -> "Point(x, y)" print Point2.__doc__ # -> "Point2(x, y)" 但这并不能解决问题。是否可以通过其他方式进行？

85 python  docstring  namedtuple 

我有一个带文档字符串的Python脚本。当命令行参数的解析不成功时，我想打印文档字符串以获取用户信息。 有什么办法吗？ 最小的例子 #!/usr/bin/env python """ Usage: script.py This describes the script. """ import sys if len(sys.argv) < 2: print("<here comes the docstring>")

78 python  docstring 

PyCharm 2.7（或PyCharm 3）是否支持自定义docstring和doctest存根？如果是这样，如何编写这种特定类型的自定义扩展？ 我当前的项目已标准化使用Google Python样式指南（http://google-styleguide.googlecode.com/svn/trunk/pyguide.html）。我喜欢PyCharm的文档字符串支持，但是目前只有两种受支持的格式是epytext和reStructureText。我想要并且愿意为自己编写一个PyCharm插件，该插件可以创建以Google或Numpydoc样式（https://pypi.python.org/pypi/sphinxcontrib-napoleon/）格式设置的文档注释存根。这里特别重要的是将PyCharm具有的类型推断功能与其他两种文档类型相结合。

75 python  pycharm  docstring  doctest  sphinx-napoleon 

我想从函数本身内部打印python函数的文档字符串。例如 def my_function(self): """Doc string for my function.""" # print the Docstring here. 目前，my_function在定义之后，我将直接执行此操作。 print my_function.__doc__ 但宁愿让函数自己执行此操作。 我已经尝试在my_function内调用它print self.__doc__ print self.my_function.__doc__，print this.__doc__但这没有用。

71 python  function  printing  docstring