2011-09-21 3 views
5

Al momento sto documentando molto del mio codice (Python) e mi chiedevo se esiste un plugin per Eclipse che può generare automaticamente una stringa doc per le mie funzioni, come Visual Studio lo fa per C# quando si scrive /// su un metodo.Autogenerazione della documentazione fittizia nel codice sorgente per Python in eclissi

Ho cercato una soluzione, ma non ho avuto fortuna: qualcuno di voi conosce una soluzione?

Esempio:

Dalla mia lista di parametri su un metodo di documentazione "fittizio" verrà creato sotto la mia definizione di un metodo come illustrato di seguito:

def myFunction(self, a, b): 
    """ 

    :param a: 
    :type a: 
    :param b: 
    :type b: 
    :return: 
    :rtype: 
    """ 
    return 'Hello, world' 
+0

penso che questo è contro, in generale, lo spirito di pitone. I parametri dovrebbero essere auto-documentanti tramite il loro nome possibilmente dettagliato. Python usa l'inferenza del tipo, quindi, un test unitario dovrebbe fallire se il tipo di argomento non corrisponde al tipo di parametro desiderato. Una documentazione su una riga dovrebbe essere sufficiente. –

+0

In molti modi sono d'accordo con te, tuttavia, non faccio quello che fa il mio utente finale. Non ha accesso ai test delle unità, e credo che un bel codice documentato che elabora un po 'più dei nomi dei miei parametri gli renda la vita più facile e possa iniziare a lavorare con la mia API un po' più velocemente. (e con meno costi) – aweis

+0

Vedo il tuo punto, ma vorrei omettere le informazioni sul tipo. –

risposta

6

Ebbene, secondo this doc, se si premere Ctrl + su un nome di metodo, otterrete ciò di cui avete bisogno.

Per il vostro esempio (EDIT: se si imposta l'opzione PyDev> Editor> Codice di stile> docstring> generazione Doctag per ottenere sempre il tipo di param), si otterrà:

def myFunction(self, a, b): 
    ''' 

    @param a: 
    @type a: 
    @param b: 
    @type b: 
    ''' 
    return 'Hello, world' 
+0

Non l'ho trovato, ma è molto vicino :) e posso vedere che nelle mie preferenze in Eclipse posso cambiare il single-qoute in double, ma, a causa del mio strumento di documentazione (Sphinx), il '@' deve essere cambiato in ':' per funzionare, ma non posso davvero vedere se è possibile! – aweis

+0

@aweis: Ho trovato come aggiungere il tipo di parametro (non ancora come modificare @ in :) –

+0

Ciao, un po 'come non ho più il tipo, cosa hai fatto per ottenere che anche questo viene generato automaticamente? - Se ottengo anche il parametro type, posso convivere con il fatto che ho bisogno di cambiare manualmente l'@ – aweis