Skip to main content

Enterprise Server 3.23 目前作为发布候选版本提供。

Skip to content

使用 TODOCS 占位符留下注释

可以使用 TODOCS 占位符来指示仍需要完成的工作。

使用 TODOCS 占位符

技术撰稿人有时会在编写文档的过程中使用占位符来提醒自己之后要回来继续处理某些内容。 此技术很有帮助,但人们始终有可能忽略占位符,而让内容直接进入生产环境。 此时,技术内容团队将唯一发现它的方式是,如果有人看到它并报告它。

为了防止疏漏,请使用字符串 TODOCS 作为占位符。 Docs 测试套件包含 Lint 分析测试,如果在 Markdown 或 YAML 文件中的任意位置找到此字符串,该测试将失败。

注意

如果您使用 VS Code 作为文本编辑器,TODO 高亮 扩展可用于高亮显示文件中“TODOCS”的出现位置。 将“TODOCS”和其他大小写变体(如“todocs”)添加到此扩展的设置。

示例

1. In the dropdown, select the settings you want to sync.

   TODOCS: ADD A SCREENSHOT OF THE SETTINGS SYNC OPTIONS

1. Click **Sign in & Turn on**, then select the account to which you want your settings to be synced.