使用 TODOCS 占位符
有时技术作家在编写文档时会使用占位符,以提醒自己稍后返回某个地方。这是一个有用的技巧,但始终存在占位符被忽略并进入生产环境的可能性。此时,Docs 团队唯一发现它的方法是有人看到它并报告它。
为了防止出现这种情况,请使用字符串 TODOCS
作为您的占位符。Docs 测试套件包含一个 lint 测试,如果它在 Markdown 或 YAML 文件中的任何位置找到此字符串,则会失败。
注意:如果您使用 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.