我有一些现有的Python 3.6代码,我想转移到Python 3.7数据类.我有一些__init__方法,包含很好的文档字符串文档,指定构造函数所采用的属性及其类型.
但是,如果我在3.7中更改这些类以使用新的Python数据类,则构造函数是隐式的.在这种情况下,如何提供构造函数文档?我喜欢数据类的想法,但如果我不得不放弃使用它们的清晰文档.
编辑澄清我目前正在使用docstrings
我正在用 Sphinx 记录我的图书馆。我有装饰器logic_object:
class logic_object:
"""Decorator for logic object class.
"""
def __init__(self, cls):
self.cls = cls
self.__doc__ = self.cls.__doc__
Run Code Online (Sandbox Code Playgroud)
我有gravity一个由以下人员装饰的课程logic_object:
@logic_object
class gravity:
"""Basic gravity object logic class.
:param float g: pixels of acceleration
:param float jf: jump force
"""
#There is more not important code.
Run Code Online (Sandbox Code Playgroud)
我的狮身人面像.rst文件是:
Mind.Existence
========================
Classes, methods and functions marked with * aren't for usual cases, they are made to help to the rest of the library. …Run Code Online (Sandbox Code Playgroud)