Ferramentas do usuário

Ferramentas do site


padroes_desenvolvimento

Essa é uma revisão anterior do documento!


Nomeclatura de tabelas e procedures

Padrões gerais

Nome de tabelas

Nomes de tabelas devem devem obedecer os seguintes critérios:

-Nomes sempre no plural.

-Todos os caracteres em maiúsculo.

-Limite de 30 caracteres.

Caso o nome da tabela ultrapasse os 30 caracteres, deverá ser utilizado a seguinte regra para abreviação das palavras:

-Cortar a palavra até a primeira letra da segunda sílaba. Ex.: PRODUTOS → PROD

Nome dos campos

Nomes dos campos de tabelas devem devem obedecer os seguintes critérios:

-Possuir o campo “ID” como chave primária.

-Todos os caracteres em maiúsculo.

-Limite de 30 caracteres.

Procedures

O nome das procedures devem representar as operações que serão executadas pelas mesmas.

Listar

Procuderes para recuperar registros devem obedecer os seguintes critérios::

-Todos os caracteres em maiúsculo.

-Limite de 30 caracteres.

-Iniciar a procedure com a palavra “GET”. Ex.: GETPRODUTOS (recupera registros na tabela de produtos).

Caso o nome da procedure ultrapasse os 30 caracteres, deverá ser utilizado a seguinte regra para abreviação das palavras:

-Cortar a palavra até a primeira letra da segunda sílaba. Ex.: PRODUTOS → PROD

Inserir ou atualizar

Procedures para inserir ou atualizar um registro devem obedecer os seguintes critérios:

-Todos os caracteres em maiúsculo.

-Limite de 30 caracteres.

-Iniciar a procedure com a palavra “ADDUPDT”. Ex.: ADDUPDTPRODUTOS (insere ou atualiza um registro na tabela de produtos).

Caso o nome da procedure ultrapasse os 30 caracteres, deverá ser utilizado a seguinte regra para abreviação das palavras:

-Cortar a palavra até a primeira letra da segunda sílaba. Ex.: PRODUTOS → PROD

Excluir

Procedures para excluir um registro devem obedecer os seguintes critérios:

-Todos os caracteres em maiúsculo.

-Limite de 30 caracteres.

-Iniciar a procedure com a palavra “DEL”. Ex.: DELPRODUTOS (exclui um registro na tabela de produtos).

Caso o nome da procedure ultrapasse os 30 caracteres, deverá ser utilizado a seguinte regra para abreviação das palavras:

-Cortar a palavra até a primeira letra da segunda sílaba. Ex.: PRODUTOS → PROD

Padrões Web

Nome de tabelas

Nomes de tabelas devem obedecer os seguintes critérios:

-Nomes no singular.

-Todos os caracteres em minúsculo.

-Possuir o predecessor “tb_”. Ex.: tb_usuario.

-Nomes compostos separados pelo caracter “_”.

-Todas as tabelas devem possuir o campo id como auto increment e primary key.

Nome dos campos

Nomes de campos devem obedecer os seguintes critérios:

-Nomes no singular.

-Todos os caracteres em minúsculo.

-Possuir o predecessor constituido de 3 caracteres. Ex.: tb_cliente → cli_nome.

-Nomes compostos separados pelo caracter “_”.

Se o predecessor se repetir, poderá ser adotado as seguintes regras:

-Para tabelas compostas por 2 nomes, pegar os 2 primeiros caracteres do primeiro nome e o primeiro caracter do segundo nome. Ex.: tb_empresa_estoque → eme_

-Para tabelas compostas por 3 nomes, pegar o primeiro caracter de cadas palavra. Ex.: tb_empresa_produto_venda → epv_.

Nomeclatura de classes, métodos e propriedades

Nome de classes

Nome de classes devem obedecer os seguintes critérios:

-Primeiro caracter em maiúsculo.

-Nomes no singular.

-Nome da tabela no qual a classe representa. Ex.: Tabela de produtos, nome da classe “Produto”.

-Quando possuir palavras compostas, adotar o formato underlinecase para PHP e camelcase para as demais linguagens.

Nome de métodos

Os nomes dos métodos devem obedecer os seguintes critérios:

-Primeiro caracter em minúsculo.

-Nomes no singular.

-Quando possuir palavras compostas, adotar o formato underlinecase para PHP e camelcase para as demais linguagens.

-O nome deve refletir a ação do método.

  1. save (para atualizar ou inserir um registro).
  2. delete (para excluir um registro).
  3. get_all ou getAll (para recuperar todos os registros).
  4. getById ou get_by_id (para recuperar o registro pelo id).

-Métodos para recuperar uma propriedade devem preceder da palavra “get” e “set” quando alteram.

Nome de propriedades

Os nomes das propriedades devem obedecer os seguintes critérios:

-Primeiro caracter em minúsculo.

-Nomes no singular.

-Quando possuir palavras compostas, adotar o formato underlinecase para PHP e camelcase para as demais linguagens.

Layout

Cabeçalho

  • Cor de fundo: #F7F7F7
  • Altura: 80px
  • Largura: 100% (exceto em aplicações web, centralizado em 1024px)
  • Logo da aplicação posicionado a esquerda e centralizado na vertical com espaçamento de 20px a esquerda

Borda que divide o cabeçalho e o menu

  • Cor de fundo: cor principal da aplicação
  • Altura: 1px
  • Largura: 100%

Aplicação Imagem Cor principal Cor secundária
Cotação #2F86D4 #81B9E8
EasyCash #6E2152 #A57C96
IntelliGroup #D91427 #EDA67C
IntelliStock #1D6437 #82A081
IntelliStock Mobile #1D6437 #82A081
IntelliCash #122C5F #7B91B4
Venda Assistida #E5701F #F3B982
Intelliweb #DBB93D #EEDBA1
GNFE #122C5F #7B91B4

  • Cor de fundo: #F7F7F7
  • Altura: 33px
  • Largura: 100% (exceto em aplicações web, centralizado em 1024px)
  • Borda inferior: 1px #D5D5D5
  • Cor da fonte: #000000
  • Fonte: Arial 13px

Barra de título

  • Degrade: Sup. #777777 Inf. #555555
  • Fonte: Arial 12px centralizado #FFFFFF

padroes_desenvolvimento.1453989490.txt.gz · Última modificação: 2016/01/28 13:58 por rafael