如何在技术写作中复数函数的名称?

时间:2013-01-16 22:14:06

标签: documentation styles comments

如何在技术写作中复用函数的名称,例如foobar

通过技术写作,我的意思是,例如,在源代码中注释文本,软件或编程元素的文档可能与相应的源代码位于不同的位置。

我应该使用

foobars
foobar`s
foobar's
foobar

2 个答案:

答案 0 :(得分:1)

我建议不要以任何方式更改函数/方法名称,因为这会引起混淆,但请参考它:

Use the fooBar functions to blah, blah, blah...

Use the fooBar methods to blah, blah, blah...

答案 1 :(得分:0)

在最后添加“s”,就像任何其他复数一样,但通过格式化来区分。

写出类似“所有substr都是......”的内容。我还将使用括号将函数名称区分为函数名称,如“所有substr()s中的......”。