跳至主要内容

使用 TODOCS 占位符留下备注

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

使用 TODOCS 占位符

有时技术作者在撰写文档时会使用占位符,以提醒自己稍后返回处理某些内容。这是一种有用的技巧,但总有占位符被忽视并进入生产环境的可能性。届时,文档团队只能在有人看到并报告后才会发现它。

为防止遗漏,请使用字符串 TODOCS 作为占位符。Docs 测试套件包含一个 linting 测试,如果在任何 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.
© . This site is unofficial and not affiliated with GitHub, Inc.