Um sistema pode muitas vezes ser desenvolvido por mais de um programador, ou mesmo por um programador e depois de alguns meses outro necessita fazer manutenção, com uma padronização levará menos tempo para entender o sistema.
- Nomenclatura arquivos
- Padrão de métodos
- Variáveis
- Objetos
- Banco de Dados
- Controles
- Procedures, Views e Functions
- Parâmetros de Procedures
- Tabela
- Campo
- Comentários
- Banco de Dados
- Sistemas
Casing
Antes de exibirmos os padrões vamos falar sobre os Casing, que são as formas disponíveis de exibir as nomenclaturas.
Pascal Casing
A primeira letra no identificador e a primeira letra de cada palavra concatenada subseqüente maiúscula . Você pode usar Pascal Casing para identificadores de três ou mais caráteres.
Exemplo: BackColor
Camel Casing
A primeira letra de um identificador é miúsculo e a primeira letra de cada palavra concatenada subseqüente é maiúsculo.
Exemplo: backColor
Uppercase
Todas as letras em maiúsculo.
Exemplo: IO
Lowercase
Todas as letras em minúsculo
Exemplo: cnn
Namespace (Sempre utilizar nos projetos). Pascal Casing
NomedaEempresa.NomedoProjeto
FRSP.Intranet.
FRSP.Itranet.UI
Controles – Camel Casing - Singular
Menu – mnuCabecalho
TreeView – ID=”tvwMenu”
DropDownList – ddlDepartamento
GridView ID="gvwNota"
Image ID="imgThread"
HyperLink ID="lnkTitulo"
Label ID="lblEmail"
TextBox ID="txtBody"
Panel ID="panEditarArtigo"
DropDownList ID="ddlDepartamento"
ObjectDataSource ID="objComentario"
DetailsView id="dvwComenatrio"
DataList ID="dlstCategoria"
Button ID="btnVote"
Localize ID="locTheme"
CheckBox ID="chkClosed"
CheckBoxList ID="chklRoles"
DataList ID="dlstOrders"
Calendar ID="cldHorario"
ListBox ID="lstCurso"
RadioButton ID="optProva"
RadioButtonList ID="optlOptions"
Wizard ID="wizEncomenda"
LinkButton ID="lnkTitle"
ImageButton ID="imgBtCadastro"
FileUpload ID="fudFotos"
MultiView ID="mvwEncomenda"
DetailsView ID="dvwColegio"
FormView ID="fvwCursos"
Repeater ID="repItems"
Nome dos arquivos .aspx – Pascal Casing
Default.aspx
Contato.aspx
AprovaOportunidades.aspx
Arquivos .ascx (Camel Case) – Crie na pasta Controls
SeletorThema.ascx
Classes (Inicia com maiúsculo e no singular) Pascal Casing
Aluno.cs
Colegio.cs
Cabeçalho
//====================================================================
// Tecnologia da Informação - FRSP//
//====================================================================
// SISTEMA: Terminal Pai Aluno
// AUTOR: Fábio Galante Mans
// CRIAÇÃO: 29/06/2006 – 11:48
// MANUTENÇÃO:
// OBSERVAÇÃO:
//====================================================================
|
Variáveis - Pascal Casing
TIPO
Char, nChar, Varchar, nVarchar, Text, nText |
Exemplo
strEmail |
|
Datetime, SmallDatetime |
dteDataMatricula |
|
Tinyint, Smallint, Integer, Bigint |
intAlunoId |
|
Bit |
bitPrimeiroContato |
|
Real |
sngTotal |
|
Float, Double |
dblTamanho |
|
Decimal |
decTamanho |
|
SmallMoney, Money |
curTotal |
|
Binary, varBinary |
binContrato |
|
Image |
imgLogo |
|
Timestamp |
tspCorrente |
|
UniqueIdentifier |
guidPaiID |
|
Sql_Variant |
varPreco |
|
Cursor |
crsInventario |
|
Boolean |
blnRetorno |
Validators - Camel Casing
RequiredFieldValidator ID="valRequireName"
RegularExpressionValidator ID="valEmailPattern"
CompareValidator ID="valComparePasswords"
ValidationSummary ID="valSummary"
Tabelas do banco
Iniciais do projeto (Lowercase) – Underline – Tabela (Plural - Pascal Casing)
Exemplo: Sistema – Notas e faltas – Colégio Rio Branco.
nfcrb_Alunos
nfcrb_Pais
nfcrb_NotasFaltas
Sistema - Intranet
intranet_Noticias
intranet_Aniversiariantes
Cabeçalho
/*
//======================================================
// Tecnologia da Informação - Fundação de Rotarianos de São Paulo
//======================================================
// SISTEMA: Intranet
// AUTOR: Fábio Galante Mans
// CRIAÇÃO: 29/06/2006 – 11:48
// MANUTENÇÃO:
// OBSERVAÇÃO:
//======================================================
*/
Campos das tabelas
ID – AlunoID, ProfessorID Pascal Casing – ID sempre no final
Demais campos Pascal Casing
Titulo
AdicionadoPor
EnderecoResidencial
Aluno
ImagemURL
Stored Procedure, Views e Functions
Iniciais do projeto (Lowercase) – Underline – Módulo que está sendo desenvolvido – Underline – Verbo (Pascal Case)
Verbos –
Obter (Select)
Inserir (Insert)
Atualizar (Update)
Excluir (Delete)
Exemplo - Sistema Agenda Faculdade
agfrb_Auditorio_ObterHorario
agfrb_Salas_InserirReserva
agfrb_Salas_ExcluirHorario
Cabeçalho
/*
//======================================================
// Tecnologia da Informação - FRSP
//======================================================
// SISTEMA: Intranet
// AUTOR: Fábio Galante Mans
// CRIAÇÃO: 29/06/2006 – 11:48
// MANUTENÇÃO:
// OBSERVAÇÃO:
//======================================================
*/
Outras sugestões são bem vindas
Fabio Galante Mans