Objetivo de escrever
Esta especificação define os arquivos de programa e o estilo de codificação envolvido no processo de escrita do programa. Esta especificação é desenvolvida com base na linguagem Delphi.
Organização dos documentos do projeto
No Delphi, os arquivos dos programas são organizados de acordo com as unidades do projeto. Em um projeto típico incluem:
Arquivos de projeto (arquivos .DRP)
Contém o código fonte Pascal do programa principal do projeto;
Arquivos de unidade (arquivos .PAS)
Arquivo fonte Pascal para cada formulário do projeto, incluindo todas as declarações e procedimentos do formulário (incluindo procedimentos de processamento de tempo);
Arquivos de formulário (arquivos .DFM)
Um arquivo binário contendo as propriedades de design de um formulário O arquivo .DFM e o arquivo .PAS de cada formulário correspondem entre si;
Arquivo de recurso (arquivo .RES)
Arquivos de recursos binários compilados vinculados ao arquivo executável do aplicativo;
Arquivo de opções do projeto (arquivo .DOF)
Armazena as opções do projeto definidas pelo comando de menu PProject|Options;
Arquivo de configurações da área de trabalho (arquivo .DSK)
Armazena as opções da área de trabalho definidas pelo comando do menu Ferramentas|Opções;
Arquivo de pacote (arquivo .DPK/.BPL)
Arquivos usados para compartilhar componentes, classes, dados e código. O arquivo fonte é um arquivo .DPK e após a compilação é um arquivo .BPL;
definição constante
contente:
Definição de valores lógicos;
Definição de valor constante;
Definição de código de erro;
Formato: Uma definição por linha. do seguinte modo:
Const<constante>: tipo = valor; //Comentário
ilustrar:
Use a instrução Const para declarar constantes usadas no lugar de valores literais.
Exemplo: Const C_SQL:string='select CH_USERER_ID de T_CD_USER' //Consulta o ID do usuário;
Const C_PI:real =3,1415926;
Definição do tipo de estrutura
Conteúdo: definição do tipo de estrutura
Formatar:
Tipo
<Nome do tipo>//Comentários da descrição da estrutura
<Nome da variável 1>: tipo de variável; //descrição da variável comentários
<Nome da variável 2>: tipo de variável; //descrição da variável comentários
…
Fim;
ilustrar:
<Nome do tipo> é uma string começando com uma letra maiúscula. As instruções que definem os tipos de variáveis na definição da estrutura começam na segunda linha e na quinta coluna.
Exemplo:
tipo
TableList=record //Definição do tipo de unidade da árvore do sistema
InID: Inteiro; //número da unidade
Nome: string; //Nome da unidade
PID: string; //Nome da unidade anterior
PT: PTableList; //Ponteiro para o próximo tipo de unidade
fim;
Estilo de programação
O estilo de programação especifica as regras de posicionamento para cada instrução e os comentários no programa.
Estilo de função/procedimento
<função/procedimento> Nome (variável: tipo de variável [,...]);//descrição da função/procedimento
var
Variável 1: tipo de variável // descrição da variável;
Variável 2: Tipo de variável //Descrição da variável;
…
começar
declaração;
declaração;
…
fim ;
Nota: As declarações e instruções de variáveis são escritas a partir da terceira coluna. Se houver recuo, recue-as duas colunas por vez e alinhe-as com as instruções correspondentes.
estilo de declaração
ilustrar:
Geralmente há uma descrição de função de parágrafo para cada dez linhas no máximo no corpo do programa;
Padronizar o uso de diversas declarações;
O recuo nas instruções está em unidades de duas colunas.
declaração de definição de variável
var
var_name: <tipo de dados>;
declaração de atribuição
var_name: = <expressão>;
declaração condicional
if condição then //Comentário
começar
declaração;
…
fim
senão se condição então //comentário
começar
declaração;
...
fim
senão // comente
declaração;
Nota: Se houver apenas uma instrução de execução, as instruções inicial e final poderão ser omitidas.
Instrução de loop
//Anotação da função de loop
para contador := início ao fim faça
começar
[declaração];
…
fim;
//Anotação da função de loop
enquanto [condição] faça
começar
[declaração];
…
fim;
//Anotação da função de loop
repita
[declaração];
…
até [condição]
declaração de mudança
//alterar descrição da função
caso <expressão> de
<valor1>:[instrução 1];
<valor2>:[instrução 2];
…
<valor>: [afirmação n]
fim;
Linha de comentários
Deve haver comentários "Descrição do Módulo" e "Descrição da Unidade" para este arquivo de unidade na parte superior do arquivo de unidade de código do programa.
Para partes de código significativas, como constantes, tipos estruturais, funções/procedimentos, variáveis personalizadas, blocos de funções de segmento de código, instruções-chave, etc.
pontos, deve haver uma linha de comentários para explicar em detalhes.
A linha de comentário pode ser adicionada com "//XXXXXXXX" após a linha que precisa ser explicada, ou também pode ser adicionada acima da linha que precisa ser explicada.
Adicione várias linhas usando "{XXXXXXXX}" ou adicione uma única linha usando "//XXXXXXXX".
Nomenclatura de arquivos e formulários
Significado do formato de nomenclatura do nome da classe
Arquivo de projeto Programa (.DPR) XXXXX
UnidadeUnidade(PAS) uXXXXX
FormulárioFormulário.Nome(.DFM) XXXXXFrm
Módulo de dadosDataModule XXXXXDM
Definição do cabeçalho da unidade, adicionada na frente de cada unidade.
{********************************************** ***
Nome da unidade:
Descrição da função:
autor:
Nome do software:
Versão:
Nome da empresa: Sword as Dream Software Creation Studio
************************************************** * *** }
Definição do formato do número da versão do software:
O software usa o seguinte formato de número de versão: XXXX
Por exemplo: após a conclusão do programa liberável, o número da versão é marcado como "1.0.0.0"
O primeiro dígito: número da versão. Nota: Esta é uma versão do software que foi significativamente melhorada.
Segundo dígito: Número de manutenção. Nota: Alguns erros foram modificados com base na versão existente.
O terceiro dígito: número do patch. Nota: Quando o programa corrige alguns erros e nenhum novo número de manutenção é formado, o número do patch é usado.
O quarto dígito: número de correção. Nota: Quando ocorre um erro de emergência no programa, o programa modificado é usado como um identificador e não como o número da versão do programa lançado. yckxzjj