2017-07-13 30 views
1

我已經使用這個奇怪的語法了很長一段時間了,並且正在相當擅長它。 這就好像是關於java的一部分,並在Python中使用它。這很棒,我喜歡它,因爲註釋,我的IDE甚至發現了一些錯誤。我一直在使用這種文檔字符串語法2年了,它叫什麼名稱,誰指定它,是否可以使用它?

然而,我不知道誰指定了這個語法,它是多麼的官方,我不知道它的確切規則。

無可否認,我使用的是PyCharm,但我不知道這是否可以在其他IDE中使用,或者它只是PyCharm語法 - 我不想這樣想,而且我想使用也適用於其他工具的文檔字符串語法。

而且,我看到他們的Python庫博託使用這種語法的亞馬遜人: https://github.com/boto/boto/blob/develop/boto/beanstalk/layer1.py#L83

下面是語法的一個例子。

def asdf(name, descriptions, weird_dict): 
    """ 
    :type weird_dict: dict[tuple[str|None],list[dict[int,str]|MyClass]] 
    :param weird_dict: description description 

    :type name: str 
    :param list[str] descriptions: Description and type annotation 

    :param str name: Here I declared the "suggested" type, and can also describe the param 

    :return: Here I just describe what's returned 
    :rtype: int 
    """ 

請告訴我,如果有人知道,這是什麼語法的名字,誰規定的,我怎麼能找到更多關於它的信息,因爲我嘗試了幾次,剛剛結束了對PyCharm現場。

回答

相關問題