从代码示例中省略多余的字符

拉斐尔·谢勒(Raphael Schaller)在Unsplash上​​拍摄的照片

摘要:不要在代码示例中使用无意义的字符。 您的读者应该能够将占位符与代码区分开。

代码中的每个字符都代表某种含义。 代码示例中的每个字符都应遵循该含义。

考虑以下示例:

大括号代码还是占位符 ? 还不清楚 让我们再试一次:

现在! 这样更好

混合占位符和代码

当示例将字符作为代码和占位符混合在一起时,多余的字符特别糟糕。 例如:

在上面的示例中, {selector}是一个占位符, {successMessage}是代码。 但是要区分两者并不容易。 让我们再试一次:

真好! 更好的是,我们可以使用占位符更加明确:

例外情况

有些字符已被普遍接受,因此省略它们可能会使您的读者感到困惑。 bash [OPTIONS]占位符就是一个很好的例子:

bash start.sh [OPTIONS] 

删除方括号将提示一些问题,例如:“ 选项是脚本中的第一个参数吗?”还是“是否需要选项 ?”。

  bash start.sh选项 

更多例子

MySQL用户名

之前

  mysql -u  -p 

后

 mysql -u YOUR_USERNAME -p 

重击第一论点

之前

 bash start.sh {build_number} 

后

 bash start.sh BUILD_NUMBER