现在的位置: 首页 > 综合 > 正文

命名规范:参数 – Parameter

2012年08月22日 ⁄ 综合 ⁄ 共 599字 ⁄ 字号 评论关闭

谨慎仔细地遵守参数命名规范很重要,提供上下文相关帮助和类浏览功能的可视化设计工具会在设计器中向用户显示方法的参数名。以下规则概述了参数的命名规范:

  • 使用 Camel Case。
  • 使用描述性的参数名。参数名必须包含足够的描述信息,以使在大多数情况下从参数名及其类型上就能判断它的意义。例如,提供上下文相关帮助的可视化设计工具在开发者键入的时候会显示方法的参数。此时参数名必须包含足够的描述信息以便开发者能够提供正确的参数。
  • 使用能描述参数含义而不是其类型的名字。开发工具会提供足够有意义的关于参数类型的信息。因此描述参数的含义可以更好地使用它。尽量只在适合使用的时候使用基于类型(type-based)的参数名。
  • 不要使用保留参数。保留参数是一种专有参数,在需要的时候可能会在未来版本中公开他们。如果在未来版本中需要更多的数据,为该方法增加一个新的重载(Overload)。
  • 不要使用匈牙利标注法给参数附加前缀。

下面是正确命名的参数的示例。

[Visual Basic]
GetType(typeName As String)As Type
Format(format As String, args() As object)As String
[C#]
Type GetType(string typeName)
string Format(string format, object[] args)

原文:Parameter Naming Guidelines

抱歉!评论已关闭.