跳至主要内容

使用TODOCS占位符留下注释

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

使用TODOCS占位符

有时,技术作家在编写文档时会使用占位符,以提醒自己稍后再返回处理某些内容。这是一种有用的技巧,但始终存在占位符被忽略并进入生产环境的可能性。此时,文档团队唯一发现它的方法是有人看到它并报告它。

为了防止这种情况发生,请使用字符串TODOCS作为您的占位符。文档测试套件包含一个代码检查测试,如果在 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.