当前位置:  开发笔记 > 编程语言 > 正文

这些标签@ivar @param和python docstring中的@type是什么?

如何解决《这些标签@ivar@param和pythondocstring中的@type是什么?》经验,为你挑选了2个好方法。

安瓿项目在docstring中使用了一些标签,就像javadoc一样.

例如,来自pool.py第86行:

def start(self, ampChild=None):
    """
    Starts the ProcessPool with a given child protocol.

    @param ampChild: a L{ampoule.child.AMPChild} subclass.
    @type ampChild: L{ampoule.child.AMPChild} subclass
    """

什么是这些标签,哪个工具使用它.



1> S.Lott..:

文档工具的标记,可能是epydoc.


是的,它们在http://epydoc.sourceforge.net/manual-fields.html中解释

2> cdleary..:

为了好玩,我会注意到Python标准库使用的是Sphinx/reStructuredText,其信息字段列表类似.

def start(self, ampChild=None):
    """Starts the ProcessPool with a given child protocol.

    :param ampChild: a :class:`ampoule.child.AMPChild` subclass.
    :type ampChild: :class:`ampoule.child.AMPChild` subclass
    """


@Andrea Francia:Epydoc非常轻量级(远不如reStructuredText那么强大),并且在reStructuredText被用作标准之前就开发得很好.它们都有充分的理由存在,但我建议用户从这里开始使用reStructuredText.
对于相同的编程语言有多少对流!坏事.
推荐阅读
Gbom2402851125
这个屌丝很懒,什么也没留下!
DevBox开发工具箱 | 专业的在线开发工具网站    京公网安备 11010802040832号  |  京ICP备19059560号-6
Copyright © 1998 - 2020 DevBox.CN. All Rights Reserved devBox.cn 开发工具箱 版权所有