Instrucciones de nomenclatura de parámetros

Es importante seguir estas instrucciones de nomenclatura de parámetros, ya que las herramientas de diseño visual que proporcionan ayuda contextual y funcionalidad de exploración de clases muestran en el diseñador los nombres de los parámetros de métodos a los usuarios. En las reglas siguientes se describen las instrucciones de nomenclatura de parámetros:

• Utilice el estilo de Mayúsculas y minúsculas Camel para los nombres de parámetros.
• Utilice nombres de parámetros descriptivos. Los nombres de parámetros deben ser lo suficientemente descriptivos como para que el nombre y el tipo del parámetro se puedan utilizar para determinar su significado en la mayoría de los escenarios. Por ejemplo, las herramientas de diseño visual que proporcionan ayuda contextual muestran los parámetros de los métodos a los programadores mientras escriben. Por tanto, los nombres de los parámetros deberían ser lo suficientemente descriptivos en este escenario como para permitir a los programadores suministrar los parámetros adecuados.
• Utilice nombres que describan el significado del parámetro, en vez de nombres que describan el tipo de parámetro. Las herramientas de desarrollo deben proporcionar información descriptiva sobre el tipo de parámetro. Por tanto, el nombre del parámetro también sirve para describir su significado. Utilice los nombres de parámetros basados en tipos con moderación y sólo cuando sea correcto.
• No utilice parámetros reservados. Los parámetros reservados son parámetros privados que se pueden exponer en futuras versiones, si así se precisa. En vez de esto, si se necesitan más datos en una versión futura de la biblioteca de clases, agregue una nueva sobrecarga para un método.
• No incluya un prefijo en los nombres de parámetros con notación húngara de tipo.

A continuación, se incluyen algunos ejemplos de parámetros con nombres correctos:

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)

Vea también

Instrucciones de diseño para programadores de bibliotecas de clases | Instrucciones de uso de parámetros