参数与参数命名:偏好还是约定?

时间:2010-12-08 08:53:36

标签: parameters naming-conventions arguments

无论这看起来多么微不足道,我无法帮助我好奇心。根据您的经验,在命名参数和参数时有哪些可读性考虑因素?参数在函数调用中,因此可以提供与函数定义中的参数不同的人类可读目的。参数名称何时应该比其对应的参数名称更具体,反之亦然,或者它们是否应该尽可能使用相同的名称?

您是否知道任何有助于决定这种或那种方式的惯例或标准?或者你会说这是留给偏好的领域吗?

提前致谢。

2 个答案:

答案 0 :(得分:2)

作为术语的参数和参数通常可以互换使用,但如果我们想要更具体,那么它通常归结为:

参数只是函数定义中的名称。

参数是一个将传递给该函数的对象。

所以,假设你有一个接受数据库连接的函数:

public void doDatabaseStuff (DatabaseConnection dbConnection) {...}

此处,dbConnection是参数。

当您实际使用此功能时,如果您使用的是Oracle数据库,则可以将DatabaseConnection命名为oracleDbConnection并将其用作以下内容:

DatabaseConnection oracleDbConnection = // some code to actually obtain that connection
doDatabaseStuff(oracleDbConnection);

在这里,我们有两件事:

  • dbConnection是参数名称
  • oracleDbConnection是参数名称

由此可以看出,参数名称通常比参数名称更“通用”,但不一定如此。您也可以使用dbConnection作为参数名称,但oracleDbConnection更有意义。

答案 1 :(得分:1)

嗯....当使用第三方/或框架方法时,您可能希望使参数名称更加简洁/除此之外,当然您希望这些符合以保持一致性...