ADS – Análise e Desenvolvimento de Sistemas
Profa. Elis Cristina Montoro Hernandes
([email protected])

Convenções de nomenclatura

Convenções de nomenclatura
2

Regras gerais
◦ Não utilizar acentos
◦ Não utilizar espaços
◦ Abreviações são aceitáveis (as vezes é uma boa
solução!)
◦ A clareza nos nomes é essencial mesmo que o
nome fique longo (o Visual Studio possui
IntelliSense que agiliza a digitação).
3

Regras gerais
◦ Os eventos não precisam de comentários porque já
são auto explicativos.
 btnSalvar_Click – É intuitivo que este seja o evento
“click” do botão btnSalvar.
◦ Todo método que não seja evento precisa de
comentários;
◦ Sempre comentar os códigos gerados
principalmente partes críticas ou complexas.
4

Nomenclatura para projetos do Visual Studio
◦ Os nomes de projetos devem ser criados contendo o
prefixo da Empresa mais o nome da empresa cliente e mais
o nome do projeto:
 <Empresa><Cliente><Projeto>
 Exemplos: MicrosoftVisualStudio
◦ Os projetos dentro da Solution do Visual Studio devem
levar o nome do projeto mais o que representam.
 Exemplos: MicrosoftFrameworkDesktop, MicrosoftFramew
orkDAO.
◦ Não criar itens dentro de uma Solution com o mesmo nome
da Solution porque o VS não saberá quando estamos nos
referindo ao rootnamespaces e poderá gerar erros.
5

Declaração de classes, estruturas e interfaces
◦ Utilizar notação Pascal Case.
◦ Não utilizar prefixos em inicio de nomes
principalmente o “C”.
◦ Não criar classes com nomes que possam conflitar
com classes do framework .net.
◦ As classes devem ser declaradas com o nome do
objeto que ela representa.
◦ Exemplos: Aluno, Matricula, Professor…
6

Membros de classes (Variáveis, atributos,
propriedades)
◦ Utilizar notação Camel Case
 string strNomeUsuario
 int intCodUsuario
◦ O nome da variável deve dizer claramente o que a
variável é.
◦ Declarar uma variável por linha, nunca na mesma
linha.
◦ Utilizar plural para arrays
 string[] strAlunosSelecionados;
7
Objetos
(componentes)
Form
UserControl
TextBox
Label
ComboBox
Image
Picturebox
Grid
GridView
Radio Button
LinkLabel
CheckBox
ListBox
Button
TreeView
DropDownList
Prefixo
Exemplo
frm
usc
txt
lbl
cbo
img
pic
grd
grv
rbt
lkl
chk
lst
btn
trv
ddl
frmFileOpen
uscLogin
txtGetText
lblTitle
cboCity
imgIcon
picHeader
grdPrices
grvClients
rbtRequerid
lklSite
chkSex
lstPrices
btnClientSave
trvMenu
ddlVendedores
8


http://www.tiexpert.net/programacao/java/nomencl
atura.php
http://www.akadia.com/services/naming_convention
s.html
9