Có cách nào để tự động hiển thị biến số var1 và var2 và giá trị init của chúng trong tài liệu nhân sư?cách hiển thị thuộc tính ví dụ trong tài liệu nhân sư?
class myClass():
"""
Description for class
"""
def __init__(self, par1, par2):
self.var1 = par1
self.var2 = par2
def method():
pass
Biến của bạn là biến mẫu, không phải biến lớp.
Không đính kèm chuỗi tài liệu (hoặc #: "nhận xét tài liệu") vào các biến, chúng sẽ không được ghi lại. Bạn có thể làm như sau:
class MyClass(object):
"""
Description for class
"""
def __init__(self, par1, par2):
self.var1 = par1 #: initial value: par1
self.var2 = par2 #: initial value: par2
def method(self):
pass
Nhưng tôi muốn để bao gồm tài liệu biến bằng cách sử dụng info fields:
class MyClass(object):
"""
Description for class
:ivar var1: initial value: par1
:ivar var2: initial value: par2
"""
def __init__(self, par1, par2):
self.var1 = par1
self.var2 = par2
def method(self):
pass
Xem thêm:
Bất kỳ cài đặt nào được yêu cầu để nhận xét #: doc được hiển thị trong trang html bởi nhân sư? Tôi đã sử dụng lệnh sphinx-apidoc để tạo các tệp .rst. – varunsinghal
@varunsinghal: có vấn đề gì không? – mzjn
Tôi đã sử dụng các nhận xét tài liệu này #: cho các biến lớp riêng tư. – varunsinghal