小编Bra*_*ram的帖子

我在哪里可以找到PEP 257文档字符串约定的正确示例?

PEP 257说:

在记录类的所有文档字符串(单行或多行)之前和之后插入一个空行 - 一般来说,类的方法通过一个空行彼此分开,并且docstring需要从第一种方法是一个空白行; 为了对称,在类头和docstring之间加一个空行.

但我似乎无法找到任何实际实现此功能的代码.

我已经检查了Python 2.6提供的几个标准模块,甚至专门搜索了提到Guido名称的模块.但即使是rietveld代码审查工具的代码也不符合恕我直言(例如http://code.google.com/p/rietveld/source/browse/upload.py):

class CondensedHelpFormatter(optparse.IndentedHelpFormatter):
   """Frees more horizontal space by removing indentation from group
      options and collapsing arguments between short and long, e.g.
      '-o ARG, --opt=ARG' to -o --opt ARG"""

   def format_heading(self, heading):
     return "%s:\n" % heading
Run Code Online (Sandbox Code Playgroud)

此多行文档字符串之前没有空白行,后面的空白行位于结束引号之外.

此类/usr/lib64/python2.6/site.py之前没有空行,但在结束引号之前和之后有一个空行.

class _Helper(object):
    """Define the built-in 'help'.
    This is a wrapper around pydoc.help (with a twist).

    """

    def __repr__(self):
Run Code Online (Sandbox Code Playgroud)

是否有可用于演示PEP 257的示例?

提前致谢

python coding-style

11
推荐指数
1
解决办法
4369
查看次数

标签 统计

coding-style ×1

python ×1