2012-06-15 21 views
6

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

+0

Proponuję użyć [Sfinks] (http: //sphinx.pocoo. org /) do dokumentacji projektów Pythona ogólnie – bmu

+0

Niestety, obecnie nie jest to opcja, dam jej szukać do następnego projektu – ted

+1

może to było narzędzie sprawdzania pisowni, które narzekało na "ALLWAYS";) –

Odpowiedz

6

Obecnie nie jest to obsługiwane w doxygen, jak wcześniej udzielono odpowiedzi here. Jeśli umieścisz komentarz na linii poprzedzającego będzie działać prawidłowo:

class escapeMode(object): 
    ''' 
    Enum to represent the escape mode. 
    ''' 
    ## Escape all values 
    ALLWAYS  = 1 
    ## Escape only values containing seperators or starting with quotation 
    NECESSARY = 2 

nadzieję, że to nie jest zbyt późno ...

+0

dzięki, to jest nieco pomocny. Zhakowałem trochę na filtr dla Pythona. Robi to samo, ale wkręca numerację linii, ponieważ wewnętrznie konwertuje ją do twojego formatu, ale za pomocą docstrukcji, dodając w ten sposób linie. Zmienię to i spróbuję wgrać to gdzieś, jeśli pozwoli na to mój pracodawca. – ted

Powiązane problemy