Django模型将模型注释同步到数据库

1、安装django-comment-migrate库

pip install django-comment-migrate 

2、将库注册到settings.py文件中

INSTALLED_APPS = [
    ...
    'django_comment_migrate',  # 表注释
    ...
]

3、加注释

3.1、给模型（表）加注释

在模型的class Meta中编辑 verbose_name，如：

class Plan(BaseModel):
    ...
    class Meta:
        verbose_name = '测试计划表'
        

3.2、给表字段加注释

设置模型字段 verbose_name字段选项，如

class Plan(BaseModel):
    ...
    name = models.CharField(verbose_name='计划名称',...)

    class Meta:
        verbose_name = '测试计划表'
        

4、执行生成数据库迁移文件

python manage.py makemigrations

5、执行数据库迁移

 python manage.py migrate 

6、执行数据库注释迁移

python manage.py migratecomment

7、查看数据库

注意：先执行完数据库迁移，最后执行注释迁移。