Propósito de escribir
Esta especificación define los archivos de programa y el estilo de codificación involucrados en el proceso de escritura del programa. Esta especificación está desarrollada en base al lenguaje Delphi.
Organización de los documentos del proyecto.
En Delphi, los archivos de programa están organizados según unidades de proyecto. En un proyecto típico se incluyen:
Archivos de proyecto (archivos .DRP)
Contiene el código fuente Pascal del programa principal del proyecto;
Archivos unitarios (archivos .PAS)
Archivo fuente Pascal para cada formulario del proyecto, incluidas todas las declaraciones y procedimientos del formulario (incluidos los procedimientos de procesamiento de tiempo);
Archivos de formulario (archivos .DFM)
Un archivo binario que contiene las propiedades de diseño de un formulario. El archivo .DFM y el archivo .PAS de cada formulario se corresponden entre sí;
Archivo de recursos (archivo .RES)
Archivos de recursos binarios compilados que están vinculados al archivo ejecutable de la aplicación;
Archivo de opciones del proyecto (archivo .DOF)
Almacena las opciones del proyecto establecidas por el comando de menú PProject|Opciones;
Archivo de configuración del escritorio (archivo .DSK)
Almacena las opciones del escritorio configuradas por el comando de menú Herramientas|Opciones;
Archivo de paquete (archivo .DPK/.BPL)
Archivos utilizados para compartir componentes, clases, datos y código. El archivo fuente es un archivo .DPK y después de la compilación es un archivo .BPL;
definición constante
contenido:
Definición de valores lógicos;
Definición de valor constante;
Definición de código de error;
Formato: Una definición por línea. como sigue:
Const<constante>: tipo = valor //Comentario;
ilustrar:
Utilice la declaración Const para declarar constantes que se utilizan en lugar de valores literales.
Ejemplo: Const C_SQL:string='select CH_USERER_ID from T_CD_USER' //Consulta ID de usuario;
Const C_PI:real =3.1415926 //Pi
Definición del tipo de estructura
Contenido: Definición del tipo de estructura
Formato:
Tipo
<Nombre del tipo>//Comentarios de descripción de la estructura
<Nombre de variable 1>: tipo de variable; //comentarios de descripción de variable
<Nombre de variable 2>: tipo de variable; //comentarios de descripción de variable
…
Fin;
ilustrar:
<Nombre del tipo> es una cadena que comienza con una letra mayúscula. Las declaraciones que definen tipos de variables en la definición de estructura comienzan en la segunda fila y la quinta columna.
Ejemplo:
tipo
TableList=record //Definición del tipo de unidad del árbol del sistema
InID: Entero; //número de unidad
Nombre: cadena; //Nombre de la unidad
PID: cadena; //Nombre de la unidad anterior
PT: PTableList //Puntero al siguiente tipo de unidad
fin;
estilo de programación
El estilo de programación especifica las reglas de posicionamiento para cada declaración y los comentarios en el programa.
Estilo de función/procedimiento
<función/procedimiento> Nombre (variable: tipo de variable [,...]);//descripción de función/procedimiento
var
Variable 1: tipo de variable; // descripción de la variable
Variable 2: Tipo de variable; //Descripción de la variable;
…
comenzar
declaración;
declaración;
…
fin ;
Nota: Las declaraciones de variables y los enunciados se escriben a partir de la tercera columna. Si hay sangría, sangría dos columnas a la vez y alinea con las declaraciones correspondientes.
estilo de declaración
ilustrar:
Generalmente hay un párrafo de descripción de función por cada diez líneas como máximo en el cuerpo del programa;
Estandarizar el uso de diversas declaraciones;
La sangría en las declaraciones está en unidades de dos columnas.
declaración de definición de variable
var
var_name: <tipo de datos>;
declaración de asignación
var_name: = <expresión>;
declaración condicional
si condición entonces //Comentar
comenzar
declaración;
…
fin
else if condición entonces//comentario
comenzar
declaración;
...
fin
más//comentario
declaración;
Nota: Si solo hay una declaración de ejecución, se pueden omitir las declaraciones de inicio y fin.
Declaración de bucle
//Anotación de función de bucle
para contador: = empezar a terminar hacer
comenzar
[declaración];
…
fin;
//Anotación de función de bucle
mientras que [condición] lo hace
comenzar
[declaración];
…
fin;
//Anotación de función de bucle
repetir
[declaración];
…
hasta [condición]
declaración de cambio
//descripción de la función de cambio
caso <expresión> de
<valor1>:[declaración 1];
<valor2>:[declaración 2];
…
<valoren>: [declaración n]
fin;
Línea de comentario
Debe haber comentarios de "Descripción del módulo" y "Descripción de la unidad" para este archivo de unidad en la parte superior del archivo de unidad del código del programa.
Para partes de código significativas, como constantes, tipos estructurales, funciones/procedimientos, variables personalizadas, bloques de funciones de segmentos de código, declaraciones clave, etc.
puntos, debe haber una línea de comentarios para explicar en detalle.
La línea de comentario se puede agregar con "//XXXXXXX" después de la línea que se debe explicar, o también se puede agregar encima de la línea que se debe explicar.
Agregue varias líneas usando "{XXXXXXXX}" o agregue una sola línea usando "//XXXXXXXX".
Nomenclatura de archivos y formularios
Significado nombre de clase formato de nomenclatura
Archivo de proyecto Programa(.DPR) XXXXX
UnidadUnidad(PAS) uXXXXX
FormularioForm.Nombre(.DFM) XXXXXFrm
Módulo de datosDataModule XXXXXDM
Definición del encabezado de la unidad, agregada delante de cada unidad.
{************************************************ * ***
Nombre de la unidad:
Descripción de la función:
autor:
Nombre del programa:
Versión:
Nombre de la empresa: Sword as Dream Software Creation Studio
************************************************** * *** }
Definición del formato del número de versión del software:
El software utiliza el siguiente formato de número de versión: XXXX
Por ejemplo: una vez completado el programa liberable, el número de versión se marca como "1.0.0.0"
El primer dígito: número de versión. Nota: Esta es una versión del software que se ha mejorado significativamente.
Segundo dígito: Número de mantenimiento. Nota: Algunos errores se han modificado según la versión existente.
El tercer dígito: número de parche. Nota: Cuando el programa corrige algunos errores y no se forma ningún nuevo número de mantenimiento, se utiliza el número de parche.
El cuarto dígito: número de corrección. Nota: Cuando se produce un error de emergencia en un programa, el programa modificado se utiliza como identificador, no como número de versión del programa lanzado. yckxzjj