Skip to main content

此版本的 GitHub Enterprise Server 已于以下日期停止服务 2024-09-25. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

使用 TODOCS 占位符留下注释

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

使用 TODOCS 占位符

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

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

Note

如果使用 VS Code 作为文本编辑器,则“TODO Highlight”扩展可用于突出显示文件中存在的“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.