正如标题所述,最好在 ER 表中添加注释。比如:
car: {
shape: sql_table
id: int {constraint: primary_key}
make: string "This is a comment describing the column"
}
或者也许
car: {
shape: sql_table
id: int {constraint: primary_key}
make: string {comment: "This is a comment describing the column"}
}
与 ER 中的 Mermaid 评论进行比较:https://mermaid.js.org/syntax/entityRelationshipDiagram.html
PERSON {
string driversLicense PK "The license #"
string(99) firstName "Only 99 characters are allowed"
}