Convenções de codificação do sistema

Propósito

Estabelecer diretrizes que devem ser utilizadas durante a escrita e a manutenção do código-fonte do sistema.

Descrição

Tecla de atalho

Alguns comandos de atalhos foram adotados a um bom tempo e já são familiares aos usuários, portanto é interessante sempre mantê-los de acordo com sua ação correspondente para que o usuário não necessite de verificar o Hint da tecla todas as vezes.

  • Ctrl+I: Incluir.
  • Ctrl+A: Alterar.
  • Ctrl+S: Visualizar.
  • Del: Deletar.

O ideal é que o comando nunca conflite com um atalho essencial do windows como por exemplo Ctrl+C ou Ctrl+V. Telas de localização que possuem atalho devem sempre utilizar uma letra que identifique o que está sendo localizado, salvo quando há conflito com atalhos do windows.

Os hints de teclas de atalho devem seguir o padrão de nomenclatura da barra de tarefa dos módulos, exceto casos específicos de ações da tecla.

  • Incluir: Incluir {ação} (Ctrl+I).
  • Alterar: Alterar {ação} (Ctrl+A).
  • Excluir: Excluir {ação} (Del).
  • Visualizar: Visualizar {ação} (Ctrl+S).

Obs: Os atalhos devem ser descritos no hint como são descritos nas actions do delphi sem espaço entro o operador, caso haja. Ex: Ctrl+I (correto) - Ctrl + I (incorreto).

Nomes

Constantes

  • Todas as constantes devem ter seus nomes escritos em letras maiúsculas;
  • Quando o nome de uma constante for composto por mais de uma palavra, estas devem estar separadas pelo caractere '_';
  • Constantes que representam nomes de arquivos devem começar com 'NOME_…';
  • Constantes que representam pastas devem começar com 'PASTA_…';
  • Constantes que representam caminhos completos de arquivos (pasta + nome) devem começar com 'CAMINHO_…';

Informações adicionais

 
softwares/monnae/requisitos/documentacao_tecnica/codigo.txt · Última modificação: 01/12/2021 11:48 (edição externa)
 
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki