convenções de nomenclatura: orientações para os verbos / substantivos e uso da gramática Inglês

StackOverflow https://stackoverflow.com/questions/412839

  •  03-07-2019
  •  | 
  •  

Pergunta

pode apontar alguém me a um site, ou me dar alguma sabedoria em como você ir sobre como escolher nomes para interfaces, classes e talvez até mesmo métodos e propriedades relacionadas com o que esse objeto ou método faz?

Este é especificamente para desenvolvimento da Microsoft, então Java-esque "doGet" e assim por diante não é realmente utilizado, no entanto, algumas regras gerais que as barreiras linguísticas cruz deve (eu teria pensado) existir.

Um exemplo pode ajudar: Eu tenho 4 opções de nomes para uma interface: 

IGroupedItem
IGroupableItem
IDataEntity
IGroupedEntity

Eles contêm um adjetivo eo substantivo, ou apenas um substantivo. Olhando para o .NET framework parece que deve haver algum tipo de conjunto de regras para isso, para manter a consistência? Além dos verbos óbvios para métodos.

Editar: Embora o exemplo é uma interface, não estou limitando esta a interfaces apenas. A orientação geral é classes são substantivos, verbos, métodos Propriedades substantivos. Suponho que eu quero dizer é escolha da sinônimo. Está jogando "Entidade" em todos os lugares errados

Foi útil?

Solução

Olhe para os artigos do MSDN para nomeação diretrizes. Em suma:

  • Use substantivos para nomes de classes e nomes de propriedades (é óbvio)
  • Para nomes de interface, comece com substantivos e / ou adjetivos I e uso para descrever o comportamento
  • Use verbos para nomes de método para descrever a ação

Para o seu exemplo -. IGroupableItem

Outras dicas

As interfaces são coisas que uma classe é capaz de fazer. Não é o que é , mas o que ele pode não . 

IGroupableItem

Outros nomes descrever o que as coisas são ou são demasiado vagas para serem úteis.

Especificamente, "IDataEntity" é em grande parte sem sentido. Afinal, tudo é uma entidade de dados.

MSDN tem um artigo apenas sobre interface Diretrizes Naming que podem ajudá-lo. Se você quiser as convenções de nomenclatura de coisas que não as interfaces, juntamente com muitas outras diretrizes de nomenclatura e de design, você pode achar que tudo no MSDN também.

Este é o mesmo material que a resposta de Spodi, mas MSDN do Diretrizes de design para a classe biblioteca Developers são principalmente excelente, cobrindo nomear e muito , muito mais.

Não é o artigo agradável Fazendo errado Código Olhe errada por Joel Spolsky. Ela fala sobre não tão popular, mas muito útil convenção de nomenclatura.

Assim como o Diretrizes MSDN, há um C # Coding documento Padrões de IDesign por Juval Lowy que é bastante útil (não sei se / quanto isso difere do MSDN).

C # Coding Standards

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top