簡體   English   中英

Sphinx docstring:指定類類型而不是對象?

[英]Sphinx docstring: specify class type instead of object?

在Sphinx中,假設您有一個采用一個參數的函數。 您的文檔字符串可能如下所示:

class A(object):
    pass

def funct1(a_object):
    """
    :type a_object: A
    """
    pass

funct1(A())

但是,如果您不是傳遞類A的對象,而是傳遞類“ A”本身,該怎么辦? 該文檔字符串看起來如何?

class B(object):
    pass

def funct2(b_class):
    """
    :type b_class: ?????
    """
    pass

funct2(B)

我認為這應該適用於類型提示,即使技術上並非100%准確:

class B(object):
    pass

def funct2(b_class):
    """
    :type b_class: () -> B
    """
    pass

funct2(B)

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM