Wie dokumentiere ich die Parameter der Python-Methode, damit sie in Intellisense und Doxygen erscheinen?

Question

Ich habe PyTools für Visual Studio 2013 verwendet und frage mich, ob es möglich ist, Parameter so zu dokumentieren, dass sowohl Intellisense als auch Doxygen sie verstehen.

Zum Beispiel ich so habe versucht (Code-Schnipsel aus PEP257 genommen):

def complex(real=0.0, imag=0.0): 
    """Form a complex number. 

    Keyword arguments: 
    real -- the real part (default 0.0) 
    imag -- the imaginary part (default 0.0) 
    """ 

    print("Test func running") 

if __name__ == '__main__': 
    complex(

... aber Intellisense scheint nicht das Argument Beschreibungen zu holen:

Answer 1

Ich kann nicht mit Intellisense sprechen, aber ich habe Doxygen mit Python verwendet. Sie können Dokumentationszeichenfolgen wie gewohnt verwenden, aber es werden die Doxygen-Symbole nicht aufgegriffen, um verschiedene Teile der Dokumentation zu analysieren. Wenn Sie das brauchen, würden Sie so etwas wie dies zu tun:

## 
    # @brief Form a complex number. 
    #  
    # Keyword arguments: 
    # @param real -- the real part (default 0.0) 
    # @param imag -- the imaginary part (default 0.0) 
def complex(real=0.0, imag=0.0): 
    print("Test func running") 

if __name__ == '__main__': 
    complex(

Es gibt ein wenig Beschreibung ist hier https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html Am unteren Rand der Seite.

Allerdings würde ich vorschlagen, eine IDE für Python wie PyCharm anstelle von Visual Studio zu verwenden. Es wird Ihnen viele Python-orientierte Tools geben, die VS nicht enthält, einschließlich der Intellisense-Typ-Funktionalität für Python.