如何在普通文本中排版代码元素?

时间:2008-08-06 18:28:39

标签: language-agnostic format

使用参数排版函数以获得可读性,简洁性和准确性的最佳方法是什么?我倾向于在函数名称func()之后放置空括号,即使实际存在函数的参数。我在包含这些论点时遇到了麻烦,但感觉段落是可读的。

对此最佳做法的想法?

2 个答案:

答案 0 :(得分:3)

我通常采用这种方法,但如果我觉得它会引起混淆,我会使用省略号:myFunction(...)

我想如果我很好,我会使用那些任何时间,我在文本中省略了函数的参数。

答案 1 :(得分:1)

我只是对我的变量和参数的名称更加小心,大多数人将能够更准确地猜测您想要在其中保存哪种类型的数据。