Model层注释风格
<h4>Model层用于存放数据库模型定义,因此,对模型的每个字段都清晰的进行注释很有必要</h4>
<ul>
<li>
<p>注释内容(字段中文名称、字段解释、枚举值及含义等)<code>枚举类型请务必在注释中写出所有枚举类型及含义</code></p>
<pre><code class="language-python">name: constr(min_length=1, max_length=50) # 视频组名称
parent_code: str = '0' # 所属父级
state: int = 1 # 视频组状态,0:停用,1:正常启用
desc: constr(min_length=1, max_length=200) = '' # 备注</code></pre>
</li>
<li>
<p>正常字段注释位置:统一对齐于最长字段后两个空格位置</p>
</li>
<li>
<p>长字段注释位置:于字段上方进行单行注释,多条注释之间空行</p>
<pre><code class="language-python">name: constr(min_length=1, max_length=50) # 视频组名称
parent_code: str = '0' # 所属父级
# 校验是否为ipv4类型
_server_ip = validator('server_ip', allow_reuse=True)(check_ipv4)
desc: constr(min_length=1, max_length=200) = '' # 备注</code></pre>
</li>
</ul>