2016-12-03 4 views
1

クラスのインスタンスであると予想されるものとクラスオブジェクトであると予想されるものを区別するために、関数の引数とクラス属性の型を文書化する標準的な方法は何ですか?自分?クラス対クラスオブジェクトのインスタンスのPythonドキュメントスタイル

class TestClass(object): 
    def __init__(self): 
     pass 

class Objectify(object): 
    def __init__(self): 
     pass  

class NeatDocumentation(object): 
    """A class demonstrating neat documentation style. 

    Attributes: 
     cls (TestClass?): A class you want to test. 
     obj (Objectify?): An instance of `Objectify` class. 
     string (str): A string because why not. 
    """ 

    def __init__(self, cls_, obj, string): 
     self.cls = cls_ # An instance can be created by executing self.cls() 
     self.obj = obj 
     self.string = string 

答えて

0

Pythonの標準は、より正確にautodocのモジュールスタイルreStructuredTextの(http://www.sphinx-doc.org/en/1.4.9/rest.html

を使用しているスフィンクスのスタイルです:あなたはきれいに文字列を持っているしたい場合は、あなたも使用することができhttp://www.sphinx-doc.org/en/1.4.8/ext/autodoc.html

をスフィンクス - ナポレオンスタイル:あなたのケースでは http://www.sphinx-doc.org/en/1.4.9/ext/napoleon.html

は、あなたが行うことができます:

:param your_param: Class to test 
:type your_param: :class:`Objectify` 

または使用したナポレオン:

Args: 
    your_param (Objectify): The :class:`Objectify` class to test 
関連する問題