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
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
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
có thể đó là một công cụ kiểm tra chính tả đã phàn nàn về 'ALLWAYS';) –