Skip to content

Commit 1cb049d

Browse files
author
yangxg
committed
完善注释
1 parent a08064b commit 1cb049d

File tree

1 file changed

+20
-50
lines changed

1 file changed

+20
-50
lines changed

blog/models.py

Lines changed: 20 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,20 @@
44

55
class Category(models.Model):
66
"""
7-
django 要求我们必须继承 models.Model 类
7+
Django 要求模型必须继承 models.Model 类
88
Category 只需要一个简单的分类名 name 就可以了。
9-
10-
CharField 指定了 name 的数据类型,
11-
CharField 是字符型,
12-
max_length 指定其最大长度,
13-
超过这个长度的分类名就不能被存入数据库。
14-
15-
当然 django 还为我们提供了各种各样的类型,
16-
如日期时间类型 DateTimeField、
17-
整数类型 IntegerField 等等。
18-
django 内置的类型全部类型可查看文档:
9+
CharField 指定了分类名 name 的数据类型,CharField 是字符型,
10+
CharField 的 max_length 参数指定其最大长度,超过这个长度的分类名就不能被存入数据库。
11+
当然 Django 还为我们提供了多种其它的数据类型,如日期时间类型 DateTimeField、整数类型 IntegerField 等等。
12+
Django 内置的全部类型可查看文档:
1913
https://docs.djangoproject.com/en/1.10/ref/models/fields/#field-types
2014
"""
2115
name = models.CharField(max_length=100)
2216

2317

2418
class Tag(models.Model):
2519
"""
26-
标签 Tag 也比较简单,
27-
和 Category 一样。
20+
标签 Tag 也比较简单,和 Category 一样。
2821
再次强调一定要继承 models.Model 类!
2922
"""
3023
name = models.CharField(max_length=100)
@@ -39,52 +32,29 @@ class Post(models.Model):
3932
title = models.CharField(max_length=70)
4033

4134
# 文章正文,我们使用了 TextField。
42-
# 比较短的字符串存储可以使用 CharField,
43-
# 但对于文章的正文来说可能会是一大段文本,
44-
# 因此使用 TextField 来存储大段文本。
35+
# 存储比较短的字符串可以使用 CharField,但对于文章的正文来说可能会是一大段文本,因此使用 TextField 来存储大段文本。
4536
body = models.TextField()
4637

47-
# 这两个列分表表示了文章的创建时间和最后一次修改时间,
48-
# 存储时间的列用 DateTimeField。
38+
# 这两个列分别表示文章的创建时间和最后一次修改时间,存储时间的字段用 DateTimeField 类型。
4939
created_time = models.DateTimeField()
5040
modified_time = models.DateTimeField()
5141

52-
# 文章摘要,可以没有文章摘要,
53-
# 但默认情况下 CharField 要求我们必须存入数据,
54-
# 否则就会报错。
55-
# 指定 blank=True 后就可以允许空值了。
42+
# 文章摘要,可以没有文章摘要,但默认情况下 CharField 要求我们必须存入数据,否则就会报错。
43+
# 指定 CharField 的 blank=True 参数值后就可以允许空值了。
5644
excerpt = models.CharField(max_length=200, blank=True)
5745

58-
# 这是分类与标签,
59-
# 分类与标签的模型我们已经定义在上面。
60-
# 我们在这里把文章对应的数据库表和分类与标签对应的表关联起来,
61-
# 但是关联形式稍微有点不同。
62-
# 我们规定一篇文章只能对应一个分类,
63-
# 但是一个分类下可以有很多篇文章,
64-
# 所以我们使用的是 ForeignKey,
65-
# 即一对多的关系。
66-
# 而对于标签来说,
67-
# 一篇文章可以有多个标签,
68-
# 同一个标签下也可能有多篇文章,
69-
# 所以我们使用 ManyToManyField,
70-
# 表明这是多对多的关系。
71-
# 同时我们规定文章可以没有标签,
72-
# 因此为标签 tags 指定了 blank=True。
73-
# 如果你对 ForeignKey、ManyToManyField 不了解,
74-
# 请看教程中的解释,
75-
# 亦可参考官方文档:
46+
# 这是分类与标签,分类与标签的模型我们已经定义在上面。
47+
# 我们在这里把文章对应的数据库表和分类、标签对应的数据库表关联了起来,但是关联形式稍微有点不同。
48+
# 我们规定一篇文章只能对应一个分类,但是一个分类下可以有多篇文章,所以我们使用的是 ForeignKey,即一对多的关联关系。
49+
# 而对于标签来说,一篇文章可以有多个标签,同一个标签下也可能有多篇文章,所以我们使用 ManyToManyField,表明这是多对多的关联关系。
50+
# 同时我们规定文章可以没有标签,因此为标签 tags 指定了 blank=True。
51+
# 如果你对 ForeignKey、ManyToManyField 不了解,请看教程中的解释,亦可参考官方文档:
7652
# https://docs.djangoproject.com/en/1.10/topics/db/models/#relationships
7753
category = models.ForeignKey(Category)
7854
tags = models.ManyToManyField(Tag, blank=True)
7955

80-
# 文章作者
81-
# 这里 User 是从 django.contrib.auth.models 导入的。
82-
# django.contrib.auth 是 django 内置的应用,
83-
# 专门用于处理网站用户的注册、登录等流程,
84-
# User 是 django 为我们已经写好的用户模型,
85-
# 这里我们通过 ForeignKey 把文章和 User 关联起来,
86-
# 因为我们规定一篇文章只能有一个作者,
87-
# 而一个作者可能会写多篇文章,
88-
# 因此这是一对多的关系,
89-
# 和 Category 类似。
56+
# 文章作者,这里 User 是从 django.contrib.auth.models 导入的。
57+
# django.contrib.auth 是 Django 内置的应用,专门用于处理网站用户的注册、登录等流程,User 是 Django 为我们已经写好的用户模型。
58+
# 这里我们通过 ForeignKey 把文章和 User 关联了起来。
59+
# 因为我们规定一篇文章只能有一个作者,而一个作者可能会写多篇文章,因此这是一对多的关联关系,和 Category 类似。
9060
author = models.ForeignKey(User)

0 commit comments

Comments
 (0)