在 DOT 文件（Graphviz 使用的图形描述语言）中，注释用于增加代码可读性，但不会影响生成的图形。

1. 单行注释

使用 // 或 # 开头（不同工具可能有差异，但 // 更通用）：

// 这是一个单行注释
digraph G {
  A -> B; # 这是边的注释
}

2. 多行注释

使用 /* */ 包裹多行内容：

/*
  这是一个多行注释，
  可以跨越多行。
*/
digraph G {
  A -> B; /* 边的注释 */
  /* 节点A的注释 */
  A [label="节点A"];
}

3. 注释的常见用途

  • 解释图的逻辑：
// 这个图描述用户登录流程
digraph LoginFlow {
  Start -> LoginPage; // 进入登录页
  LoginPage -> Dashboard [label="成功认证"];
}
  • 临时禁用代码：
// A -> C; // 暂时禁用这条边
A -> B;

注意事项

  • 注释不能嵌套（如 /* /* 嵌套 */ */ 会报错）。
  • 注释符号需成对匹配（如 /* 必须有对应的 */）。
  • 注释不会出现在生成的图像中，仅保留在源文件中。

完整示例

/*
  示例：家庭关系图
  作者：Alice
  日期：2023
*/
graph Family {
  // 父母节点
  Dad [label="父亲"];
  Mom [label="母亲"];

  // 子女节点
  Child1 [label="儿子"];
  Child2 [label="女儿"];

  // 边表示亲子关系
  Dad -- Child1;
  Mom -- Child1;
  Dad -- Child2;
  Mom -- Child2;
}

通过合理使用注释，可以让 DOT 文件更易维护和理解！