używam doxygen i mają następujący kod:Dokumentacja po członków w python (z 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
Z jakiegoś powodu doxygen mówi mi, że self._stream
(Member _stream
) jest nieudokumentowana. czy mogę to udokumentować komentarzem, tak jak doxygen docu opisuje numer Putting documentation after members, a jeśli tak, to w jaki sposób?
** edit: ** to wydaje się być związana mi nie mając nową linię, na przykład tutaj:
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 narzeka tylko o ALLWAYS
jest nieudokumentowane, chciałbym uniknąć wstawianie nowych linii za każdym nowy atrybut dokumentuję w ten sposób, ponieważ niszczy on wartość nowych linii oddzielania bloków logicznych, takich jak pętle lub instrukcje z otaczającego kodu
Proponuję użyć [Sfinks] (http: //sphinx.pocoo. org /) do dokumentacji projektów Pythona ogólnie – bmu
Niestety, obecnie nie jest to opcja, dam jej szukać do następnego projektu – ted
może to było narzędzie sprawdzania pisowni, które narzekało na "ALLWAYS";) –