2012-06-15 24 views
6

Tôi đang sử dụng doxygen và có đoạn mã sau:Tài liệu sau khi các thành viên trong python (với 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 

Đối với một số lý do doxygen nói với tôi rằng self._stream (Member _stream) là không có giấy tờ. Tôi có thể ghi lại nó bằng một bình luận, như docxy doxygen mô tả ain Putting documentation after members và nếu có, đúng cách là gì?

** chỉnh sửa: ** này dường như có liên quan đến tôi không có dòng sản phẩm mới, ví dụ ở đây:

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 chỉ phàn nàn về ALLWAYS là không có giấy tờ, tôi muốn tránh chèn dòng mới đằng sau mỗi thuộc tính mới Tôi ghi lại theo cách này vì nó phá hủy giá trị của dòng mới cho các khối lôgic tách biệt như vòng lặp hoặc nếu các câu lệnh từ mã xung quanh

+0

tôi sẽ đề nghị để sử dụng [Sphinx] (http: //sphinx.pocoo. org /) cho tài liệu của các dự án Python nói chung là – bmu

+0

không may là hiện tại không phải là một lựa chọn, tôi sẽ cung cấp cho nó một dự án tiếp theo – ted

+1

có thể đó là một công cụ kiểm tra chính tả đã phàn nàn về 'ALLWAYS';) –

Trả lời

6

Điều này hiện không được hỗ trợ trong doxygen, như đã trả lời trước đây here. Nếu bạn đặt những nhận xét trên dòng preceeding nó sẽ làm việc tốt:

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 

Hope đó không phải là quá muộn ...

+0

cảm ơn, điều này có phần hữu ích. Tôi đã hack một chút trên một bộ lọc cho python. Nó làm điều tương tự nhưng nó vít lên đánh số dòng vì nó chuyển nội bộ nó sang định dạng của bạn, nhưng với docstrings, do đó thêm dòng. Tôi sẽ thay đổi nó và cố gắng tải nó lên một nơi nào đó nếu chủ lao động của tôi cho phép. – ted

Các vấn đề liên quan