Compartilhar via


Nomes de membros tipo

Tipos de conter os seguintes tipos de membros:

  • Métodos

  • Propriedades

  • Campos

  • Eventos

As diretrizes nesta seção ajudam os designers de biblioteca de classes selecionar nomes de membros que são consistentes com o.NET Framework.

Nomes dos métodos

Dar nomes de métodos são verbos ou frases de verbo.

Normalmente métodos atuam nos dados, portanto, o uso de um verbo para descrever a ação do método facilita para os desenvolvedores a entender o que faz o método. Ao definir a ação executada pelo método, certifique-se de selecionar um nome que fornece a clareza do ponto de vista do desenvolvedor. Não selecione um verbo que descreve como o método funciona; em outras palavras, não use os detalhes de implementação para o seu nome de método.

Nomes de propriedades

Nomeie as propriedades usando um adjetivo, locução substantiva ou um substantivo.

Frases de substantivo ou adjetivos são apropriados para propriedades porque propriedades contêm dados.

Não use as propriedades que correspondem aos nomes de métodos Get.

Por exemplo, não nomear uma propriedade EmployeeRecord e também um método de nome GetEmployeeRecord. Os desenvolvedores não saberá qual membro usar para realizar a tarefa de programação.

Nomeie as propriedades booleanas com uma frase afirmativa (CanSeek em vez de CantSeek). Opcionalmente, você também pode prefixar booleano propriedades com é o Can, ou tem, mas somente onde ele adiciona o valor.

Considere a possibilidade de atribuir o mesmo nome como seu tipo de uma propriedade.

Quando você tem uma propriedade que é digitada altamente para uma enumeração, o nome da propriedade pode ser o mesmo que o nome da enumeração. Por exemplo, se você tiver uma enumeração denominada CacheLevel, uma propriedade que retorna um dos seus valores também pode ser nomeada CacheLevel.

Nomes dos eventos

Nome de eventos com um verbo ou uma frase verbal.

Dar nomes de evento a um conceito de antes e depois, usando o indicativo do passado e presente. Por exemplo, um evento de fechamento é gerado antes de fechar uma janela seria chamado de fechamento, e aquele que é gerado após a janela for fechada seria chamado fechado.

Não use antes ou depois de prefixos ou sufixos para indicar o pré e postar eventos.

Nomeie os manipuladores de eventos (delegados usados como tipos de eventos) com o sufixo EventHandler.

Use dois parâmetros chamados sender e e em assinaturas de manipulador de eventos.

O sender parâmetro deve ser do tipo Objecte o e parâmetro deve ser uma instância ou herdar de EventArgs.

Nome do evento classes de argumento com o sufixo do EventArgs.

Nomes de campos

As diretrizes de nomeação para campos aplicam-se os campos public e protected estáticos. Você deve definir os campos de instância público ou protegido. Para obter mais informações, consulte Design de campo.

Use Pascal casing nos nomes de campo.

Nome campos com substantivos ou frases de substantivo.

Não use um prefixo para nomes de campo. Por exemplo, não use g _ ou s_ para distinguir estática versus campos de não-static.

Portions Copyright 2005 Microsoft Corporation. Todos os direitos reservados.

Portions Copyright Addison-Wesley Corporation. Todos os direitos reservados.

Para obter mais informações sobre as diretrizes de design, consulte a "diretrizes de Design do Framework: Convenções, idiomas e padrões de reutilizável.Bibliotecas de rede" catálogo por 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