Warning: file_get_contents(/data/phpspider/zhask/data//catemap/1/ms-access/4.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Documentation 如何将函数多元化';谁的名字在技术写作中?_Documentation_Styles_Comments - Fatal编程技术网

Documentation 如何将函数多元化';谁的名字在技术写作中?

Documentation 如何将函数多元化';谁的名字在技术写作中?,documentation,styles,comments,Documentation,Styles,Comments,在技术写作中如何将函数名(如foobar)复数化 例如,我所说的技术写作是指源代码中的注释文本、软件或编程元素的文档,这些文档可能与相应的源代码位于不同的位置 我应该用吗 foobars foobar`s foobar's foobar ?我建议不要以任何方式更改函数/方法名称,因为那样会引起混淆,但请参考以下内容: Use the fooBar functions to blah, blah, blah... 或 像其他复数形式一样,在结尾添加“s”,但通过格式区分 写一些类似“所有的su

在技术写作中如何将函数名(如
foobar
)复数化

例如,我所说的技术写作是指源代码中的注释文本、软件或编程元素的文档,这些文档可能与相应的源代码位于不同的位置

我应该用吗

foobars
foobar`s
foobar's
foobar

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

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

像其他复数形式一样,在结尾添加“s”,但通过格式区分


写一些类似“所有的
substr
s都是…”的东西。我还将使用括号将函数名区分为函数名,如“所有substr()都是…”。

如果是注释或文档,为什么不遵循普通英语(或您的语言)标准?为什么要在文档中更改函数的名称,这可能会让用户感到困惑。你能举个例子说明你是如何在一个句子中使用它的吗?你从来没有,从来没有在任何地方引入撇号来表示复数。我自己也不喜欢它,但有一些手册建议在特定情况下使用撇号,如复数小写字母(例如。“用x标记错误答案”。这主要是因为xs令人困惑。其他示例包括否和否,可能和可能)这里:Op问的是如何复数,而不是如何指定所有格form@Madbreaks啊…我的错。你为什么要对一个函数/方法进行复数化?我认为这是正确的答案!意思是,你不会t@Madbreaks我想对于一些可以重写java等方法的语言,您可能会说,
使用类的toString如果有一个toString(intx)和toString(intx,inty)之类的东西,或者如果有同一方法的几个变体,例如:intadd(intx,inty);double add(double x,double y),“add”?“add函数”?变量呢?假设我使用了很多变量I作为索引。是“is”还是“is”“i’s”或“i variables”或“is”或“is”或“is”如果你没有格式怎么办?你真的没有格式吗?你在写什么?只是在玩魔鬼游戏…例如,自述文件你在ASCII源文件中做什么标记/没有不同的字体?
Use the fooBar methods to blah, blah, blah...