sto usando Doxygen e hanno il seguente codice:documentazione dopo che i membri in pitone (con doxygen)
def __init__(self):
'''
'''
if not '_ready' in dir(self) or not self._ready:
self._stream = sys.stderr ##!< stream to which all output is written
self._ready = True ##!< @internal Flag to check initialization of singelton
Per qualche ragione mi dice che doxygen self._stream
(Member _stream
) è senza documenti. posso documentarlo con un commento, come il doxygen docu descrive ain Putting documentation after members e se sì, che cosa è nel modo giusto?
** Edit: ** Questo sembra essere correlato a me non avendo nuova linea, per esempio qui:
class escapeMode(object):
'''
Enum to represent the escape mode.
'''
ALLWAYS = 1 ##!< Escape all values
NECESSARY = 2 ##!< Escape only values containing seperators or starting with quotation
Doxygen lamenta solo di ALLWAYS
essendo privi di documenti, vorrei evitare di inserire nuove righe dietro ogni nuovo attributo Documento in questo modo poiché distrugge il valore di newline per separare i blocchi logici come loop o se istruzioni dal codice circostante
vorrei suggerire di usare [Sphinx] (http: //sphinx.pocoo. org /) per la documentazione dei progetti Python in generale – bmu
sfortunatamente quella non è attualmente un'opzione, darò un'occhiata al prossimo progetto – ted
forse era uno strumento di controllo ortografico che si lamentava di 'ALLWAYS';) –