| title | description | ms.date | helpviewer_keywords | ms.assetid | ||
|---|---|---|---|---|---|---|
Naming Parameters |
Learn guidelines for the naming of parameters. For example, use descriptive parameter names & camel casing, & consider naming based on meaning instead of type. |
10/22/2008 |
|
ca3c956e-725a-441b-b4e3-eab5d472f41c |
[!INCLUDE not-current]
Beyond the obvious reason of readability, it is important to follow the guidelines for parameter names because parameters are displayed in documentation and in the designer when visual design tools provide Intellisense and class browsing functionality.
✔️ DO use camelCasing in parameter names.
✔️ DO use descriptive parameter names.
✔️ CONSIDER using names based on a parameter’s meaning rather than the parameter’s type.
✔️ DO use left and right for binary operator overload parameter names if there is no meaning to the parameters.
✔️ DO use value for unary operator overload parameter names if there is no meaning to the parameters.
✔️ CONSIDER meaningful names for operator overload parameters if doing so adds significant value.
❌ DO NOT use abbreviations or numeric indices for operator overload parameter names.
Portions © 2005, 2009 Microsoft Corporation. All rights reserved.
Reprinted by permission of Pearson Education, Inc. from Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries, 2nd Edition by Krzysztof Cwalina and Brad Abrams, published Oct 22, 2008 by Addison-Wesley Professional as part of the Microsoft Windows Development Series.