Question

我正在使用Eclipse + PyDev中的Python。当我从＆＃34;模块：CLI（argparse）＆＃34;创建新模块时模板，Eclipse在文件的开头创建以下注释块。

#!/usr/local/bin/python2.7
# encoding: utf-8
'''
packagename.newfile -- shortdesc

packagename.newfile is a description

It defines classes_and_methods

@author:     user_name

@copyright:  2015 organization_name. All rights reserved.

@license:    license

@contact:    user_email
@deffield    updated: Updated
'''

它似乎有某种结构，我猜它是由某种东西解析的？我有几个问题：

如何调用此类评论结构以及使用哪种程序？
如何在@license？
什么是updated字段？

Answer 1

此表单中的大多数Python文档都遵循Epydoc标准。

http://epydoc.sourceforge.net/manual-fields.html显示您上面列出的所有字段的详细信息。然后，可以通过Epydoc和从中创建的文档来解析此文件。

以下示例显示允许多行文档：

def example():
    """
    @param x: This is a description of
        the parameter x to a function.
        Note that the description is
        indented four spaces.
    @type x: This is a description of
        x's type.
    @return: This is a description of
        the function's return value.

        It contains two paragraphs.
    """
    #[...]

这来自http://epydoc.sourceforge.net/epydoc.html#fields

updated部分显示了添加任何@style注释的功能。见http://epydoc.sourceforge.net/epydoc.html#adding-new-fields。

所以@deffield updated: Updated意味着有一个新的注释@updated。这将使用如下

"""
@updated 17/02/2015
"""

然后将其渲染到从Epydoc创建的HTML中。

这个结构化评论是什么？“更新”字段是什么？

1 个答案: