Skip to main content

概述

使用 Markdown 格式的评论为文档补充上下文信息,让人类和 AI 都能更好地理解您的内容。

Markdown 评论

评论系统概述

MemoryLake 的评论系统基于 Markdown,您可以为任意文件或文件夹撰写带格式的富文本笔记。 特性
  • Markdown 格式:标题、列表、粗体、斜体、代码块、链接
  • 实时预览:边输入边查看渲染结果
  • 自动保存:草稿保护,避免内容丢失

创建评论

1

打开评论编辑器

选中一个文件或文件夹,打开评论面板(通常位于右侧)。
2

撰写评论

在 Markdown 编辑器中撰写评论。可用语法包括:
  • # Headers 组织结构
  • **bold***italic* 用于强调
  • - Lists 用于罗列
  • `code` 标注技术术语
  • [links](url) 添加引用
3

预览内容

实时预览面板会显示 Markdown 的渲染效果。
保存前用预览确认格式,尤其是包含表格或代码块的复杂 Markdown。
4

保存评论

点击「保存」,评论即随文件一起存储。

Markdown 语法参考

以下是常用 Markdown 格式的快速参考:

标题

文本格式

列表

链接与图片

代码块

引用块

表格

评论示例

评论管理

编辑评论

修改已有评论:
  1. 选中文件或文件夹
  2. 打开评论面板
  3. 编辑 Markdown 文本
  4. 保存更改

删除评论

彻底删除评论:
  1. 打开评论编辑器
  2. 清空全部文本
  3. 点击「保存」
删除评论不可撤销。如果日后可能还需要这些信息,建议改为加上「已废弃」标题保留。

最佳实践

建议
  • 简洁而完整
  • 用标题组织较长的评论
  • 补充他人未必知晓的背景
  • 链接到相关文档
  • 内容变更时同步更新评论
避免
  • 写成长篇大论(保持可快速浏览)
  • 在共享文件的评论中写入敏感信息
  • 重复文件本身已有的信息
  • 留下过时的评论
  • # 标题构建结构
  • 列表让内容易于浏览
  • 加粗突出关键术语
  • 代码块承载技术内容
  • 表格承载结构化数据
  • 用链接串联相关文档
  • 标题按层级递进使用(先 H1 再 H2,不要从 H1 直接跳到 H3)
  • 提供描述性链接文本(而非「点击这里」)
  • 为图片添加替代文本
  • 语言保持清晰简单
  • 用列表提升屏幕阅读器的可读性

与项目的集成

评论可以增强项目工作流:
  • 项目上下文:文档关联到项目后,评论会一并作为上下文提供
  • AI 理解:通过 MCP 服务器接入的 AI 模型可以读取评论,理解文档用途
  • 团队协作:评论帮助团队成员理解文档之间的关系与来龙去脉
  • 搜索:评论可被搜索,让文档更容易被找到

后续步骤

文件操作

了解文件与文件夹的基础操作

项目关联

将文档关联到项目

文件库 API

通过 API 以编程方式管理文件