Convenções de nomeação gerais

As convenções de nomenclatura Geral discutem escolher os melhores nomes para os elementos em suas bibliotecas. Essas diretrizes também se aplicam a todos os identificadores. sistema autônomo seções posteriores discutem nomes elementos específicos sistema autônomo namespaces ou propriedades.

Opções do palavra

escolher nomes de identificador com com facilidade legível.Por exemplo, uma propriedade chamada HorizontalAlignment é mais legível em inglês que AlignmentHorizontal.

Favorecer legibilidade sobre questões de brevidade.O nome da propriedade CanScrollHorizontally é melhor do que ScrollableX (uma referência obscura para o eixo X).

Não use sublinhados, hifens ou qualquer Outros caractere nonalphanumeric.

Não use a notação húngara.

Notação húngara é a prática de incluir um prefixo em identificadores para codificar alguns metadados sobre o parâmetro, sistema autônomo o tipo de dados do identificador.

Evite o uso de identificadores que estão em conflito com palavras-chave das linguagens de programação amplamente utilizadas.

Embora linguagens compatíveis compatível compatível com CLS devem fornecer uma maneira de usar palavras-chave sistema autônomo palavras comuns, sistema autônomo práticas recomendadas ditam que não force sistema autônomo desenvolvedores sabe sistema autônomo fazer isso. A maioria das linguagens de programação, a documentação de referência de linguagem contém uma lista de palavras-chave usado pelos idiomas. A tabela a seguir fornece links para a documentação de referência para algumas linguagens de programação amplamente utilizadas.

Linguagem	Link
C#	Referência C#
C++	Referência da Idioma C++
Visual Basic	Referência do Visual Basic

Abreviações e acrônimos

Em geral, você não deve usar abreviações ou acrônimos. Esses tornar seus nomes menos legível. Da mesma forma, é difícil saber quando é seguro pressupor que o acrônimo é amplamente reconhecido.

Para regras de uso de maiúsculas e minúsculas para abreviações, consulte Regras de uso de maiúsculas e minúsculas para acrônimos.

Não use abreviações ou contrações sistema autônomo partes de nomes de identificador.

Por exemplo, use OnButtonClick em vez de OnBtnClick.

Não use qualquer que não são amplamente aceitas, acrônimos e, em seguida, quando necessário.

específico a um linguagem Nomes

Use nomes semanticamente interessantes em vez de palavras-chave específicas do linguagem para nomes de tipo.Por exemplo, GetLength é um nome que GetInt melhor.

Use um nome genérico de tipo de tempo de execução (CLR) de linguagem comum, em vez de um nome de específico a um linguagem, raramente quando um identificador não tem nenhum significado semântico além do seu tipo.

Por exemplo, um método que converte dados Int16 deve ser nomeado ToInt16, não ToShort porque Short é o nome do tipo específico a um linguagem Int16.

A tabela a seguir mostra os nomes de tipo específico a um linguagem para linguagens de programação comuns e a contraparte do CLR.

Nome do tipo translation from VPE for Csharp	Nome do tipo Visual Basic	Nome do tipo de JScript	Nome do tipo Visual C++	Ilasm.exe representação	Nome do tipo CLR
sbyte	SByte	sByte	char	int8	SByte
Byte	Byte	Byte	unsigned char	int8 não assinado	Byte
short	Short	short	short	Int16	Int16
ushort	UInt16	ushort	unsigned short	int16 não assinado	UInt16
int	Integer	int	int	Int32	Int32
uint	UInt32	uint	unsigned int	int32 não assinado	UInt32
long	Long	long	__int64	Int64	Int64
ulong	UInt64	ulong	unsigned __int64	int64 não assinado	UInt64
float	Single	float	float	float32	Single
double	Double	double	double	float64	Double
bool	Boolean	booliano	bool	bool	Boolean
char	Char	char	wchar_t	char	Char
string	String	string	String	string	String
object	Objeto	object	Objeto	object	Objeto

Use um nome comum, sistema autônomo valor ou item, em vez de repetir o nome do tipo, raramente quando um identificador não tem nenhum significado semântico e o tipo do parâmetro não é importante.

Partes direitos autorais 2005 Microsoft Corporation. Todos os direitos reservados.

Partes direitos autorais Addison-Wesley Corporation. Todos os direitos reservados.

Para obter mais informações sobre diretrizes de design, consulte a "diretrizes de design do estrutura: Catálogo de convenções, idiomas e padrões para bibliotecas do .NET reutilizável"Krzysztof Cwalina e Brad Abrams, publicado pela Addison-Wesley, 2005.

Consulte também

Outros recursos

Diretrizes de Design para desenvolvimento bibliotecas de classe

Diretrizes para nomes