问题背景: 我正在为 API 编写文档,其中包括快速入门指南之类的内容。该指南包含一些代码块,旨在供开发人员复制。然后开发人员可以在他们的代码中插入用例特定的内容,例如某些函数参数。
主要目标: 我希望开发人员使用复制的带占位符的代码示例的体验尽可能快速和简单。我希望在将代码粘贴到开发人员的代码中后立即看到必须插入参数,并且此过程尽可能快。以下示例中的占位符不是必需的。目标是让开发人员易于理解和快速实施。
现有示例:
例如,在 Xcode 中,一段代码可以用符号 标记为参数占位符<#PlaceholderText#>
。按照惯例,占位符文本是要插入的值的类型。当它被粘贴到编辑器中时,占位符会突出显示,可以通过点击 tab 来选择。因此,apiExampleFunction(name: <#String#> /* thing one's name */, height: <#Int#> /* thing one's height */)
只需输入 tab “thing one” tab “2” 即可填写,在编辑器中看起来如下:
IntelliJ 似乎有一个类似参数占位符功能
笔记:在某种程度上,我的大量谷歌搜索被很多其他名为占位符的东西严重挫败。如果这很简单而且众所周知,我很抱歉,任何帮助都会很感激。