Hay comentarios en un programa Delphi. Ejemplo de declaración de variables globales. Plantilla generada por shell de Delphi

, los nombres de los parámetros desaparecen en alguna parte. Y en general, la ayuda resultante resulta prácticamente ilegible: (Parece que los desarrolladores simplemente no terminaron esta función, sino que la iniciaron y la dejaron como está. El segundo método, como muchas cosas en Delphi, no es del todo obvio: utilizamos la utilidad suministrada con el IDE. XMLDoc . Se puede encontrar en la carpeta.<версия Delphi>Mis documentos\RAD Studio\\Demostraciones\XMLDoc . Además, necesitarás instalar Java SDK (1.4.2 o superior), Python (mínimo 2.3) y (versión 6.5.5 para Java). Después de la instalación necesitará agregar a la variable del sistema “ Camino ” rutas donde están instalados Python y Saxon, por ejemplo “ C:\Python23\;C\Saxon655\” (esto se hace a través de “Mi PC”, y en él - “ Variables de entorno ", las rutas deben agregarse separadas por punto y coma). En la carpeta donde extrajiste Saxon, crea archivo BAT con nombre saxon.bat

@con el siguiente contenido: "<путь к папке с Saxon>tarro java

\saxon.jar" %1 %2 %3 No es necesario ejecutarlo. Cree un archivo BAT en la carpeta con XMLDoc inicio.bat para no perder el tiempo con línea de comando

, y escribe lo siguiente en él:<путь к папке с проектом>Cls xmldoc.py "

Una ruta de ejemplo es “C:\Projects\TestProject”. Importante: Todas las rutas utilizadas no deben contener cirílico; de lo contrario, XMLDoc tendrá problemas con él. Entonces, ahora todo está listo y puede ejecutar el archivo start.bat. Si todo va bien, aparecerá una carpeta en la carpeta del proyecto. doc , y en él - final en el que serán almacenados archivos HTML

documentación generada. Esto es lo que obtuve (usando el método OpenTables como ejemplo): Por evaluación subjetiva esta opción Se ve más bonito que el primero. Todo parece ir genial, pero se ve agravado por el hecho de que XMLDoc también cortó el enlace por descuido. . Cabe señalar que estos archivos HTML no son la versión final; pueden (y, en teoría, deberían) convertirse al formato Ayuda 2.0 (luego se pueden ver a través de Explorador de documentos

, lo mismo que la ayuda en Delphi o Visual Studio). Para hacer esto, necesitará el kit de integración de ayuda de Visual Studio y luego el kit de ayuda CodeGear. Como ya no tenía nervios y el resultado ya estaba en principio claro, no fui más lejos. Quizás seas más fuerte :)

Generando documentación usando Doc-O-Matic Express Doc-O-Matic - suficiente poderosa utilidad para crear documentación para basado en XML y comentarios de JavaDoc en formatos HTML

, CHM y Ayuda 2.0. Pero, lamentablemente, su versión completa es de pago. Pero no todo es tan malo: hay una versión Express (probablemente tomaron el nombre de Microsoft) y tiene casi todo lo que necesitas. Probémoslo. Con Doc-O-Matic no tendrás que bailar tanto con pandereta como con XMLDoc, pero tampoco te las arreglarás con un par de clics. Ejecute la utilidad en la sección. Archivos de proyecto haga clic en el botón Agregar , en el filtro de diálogo seleccione Proyecto Delphi 2007 y abierto archivo requerido proyecto. en la pestaña HTML presta atención a la sección Archivos y carpetas

— en él puede especificar la carpeta donde se colocará el archivo de documentación. Guarde la configuración en algún lugar conveniente, por ejemplo en el archivo C:\mydoc.dox-express. Ahora cierre la utilidad y vaya a la carpeta donde está instalado Doc-O-Matic. Cree un archivo BAT con la siguiente línea:<путь к файлу *.dox-express>"

Domexpress.exe -config "HTML"

Después de ejecutar este comando, los archivos de documentación se colocan en la carpeta especificada anteriormente y el navegador se inicia automáticamente. Por ejemplo, así es como se verá la descripción del método: Nuevamente, subjetivamente, esa ayuda produce la impresión más favorable. Sin puntos extra

En lugar de un epílogo. La compatibilidad con comentarios XML en el nivel del editor de código en Delphi es una característica excelente y conveniente, y debería usarla. Pero con la generación de documentación la situación es más complicada: medios estándar demasiado crudo (y, para ser honesto, torcido =) para ser usado fácilmente. Pero existe una alternativa: Doc-O-Matic Express, que hace este trabajo bastante bien. Esperemos que pronto (tal vez con el lanzamiento de nuevas versiones de Delphi) aparezcan utilidades nuevas y más flexibles.

Los comentarios son cualquier texto que no tiene ningún efecto en el código del programa. Nunca compila ni pega en archivo ejecutable, pero se utiliza sólo para explicaciones de código.

Los comentarios se pueden formatear de dos maneras:

1. todo lo que viene después de la doble barra // , se percibe como un comentario
   (sólo puedes formatear una línea de comentario de esta manera);
2. Todo lo que esté entre llaves (y) también es un comentario.
   (en este caso, puedes incluir tantas líneas como quieras en el comentario).

Ejemplo de comentario

Esto ya no es un comentario.

(Este es un comentario nuevamente
Y esto también)

Este artículo utilizará constantemente comentarios para explicar el código de los programas descritos. Por eso teníamos que conocerlos antes de empezar a analizar el código.

Ahora estás listo para aprender el lenguaje de programación Delphi. Crear nuevo proyecto. Después de eso, ve al editor de código. El esquema del futuro programa ya está escrito aquí.

Echemos un vistazo más de cerca a lo que está escrito aquí. A continuación se muestran comentarios detallados para cada línea de la plantilla creada. Sin embargo, aquí falta algo para facilitar el estudio del código del programa.

Plantilla generada por shell de Delphi

interfaz

usos //Después de esto las palabras estan llegando listado de módulos conectados.
Windows, Mensajes, SysUtils, Variantes, Clases, Gráficos, Controles, Formularios,
Diálogos;

tipo //Después de esto viene la declaración de tipos
TForml = clase(Formulario T) //Comienza la descripción de un nuevo objeto TForm. Los componentes y eventos del formulario se describen aquí.
privado //Después de esta palabra puedes describir los datos privados del objeto.
(Declaraciones privadas)
disponible sólo para el objeto TForml
público //Después de esta palabra puedes describir los datos abiertos del objeto.
(Declaraciones públicas) //Pista generada por Delphi. Aquí puede describir variables y métodos,
accesible desde cualquier otro módulo
fin; //Fin de la declaración de tipo

var //Declarando variables globales
Formulario: TForml; //Esto describe la variable Forml del tipo de objeto TForml

implementación

($R *.dfm) //Archivo Connect.dfm (archivo con datos sobre objetos visuales)

fin. // termina con un punto - fin del módulo

Si algo no está claro, entonces en el proceso de creación programas reales todo encajará. No intentes recordar todo a la vez porque es imposible. Demasiado nueva información, no respaldado por la práctica. Trate de comprender sólo el significado del programa escrito.

Casi todas las líneas terminan en " ; " (punto y coma). Este signo indica el final de una declaración. Solo se usa después de declaraciones y nunca después de palabras clave como

usos, tipo, inicio, implementación, privado, público

Etc. Posteriormente, te familiarizarás con todas las palabras clave, la mayoría de las cuales destacan en negrita. La excepción es inmediatamente visible: la última en el módulo. fin, seguido de un punto en lugar de un punto y coma.

Entonces, veamos la estructura del código. Al principio está el nombre del módulo. Puede ser cualquier cosa, pero es igual que el nombre del archivo (sin tener en cuenta su extensión). No es recomendable cambiar el nombre del módulo manualmente. Si aún necesita cambiarlo, primero guarde el módulo con el nombre anterior. Para hacer esto, seleccione el comando de menú: Archivo | Guardar como(Archivo | Guardar como).

Es recomendable dar módulos. nombres claros. En este caso, puede determinar por el nombre qué hay dentro del módulo del mismo nombre. Es difícil adivinar qué hay en el archivo llamado Unitl.pas. También es recomendable dar nombres a los archivos que se relacionen con su contenido. Por ejemplo, formulario principal Es mejor guardar los programas en un archivo llamado MainUnit.pas o MainModule.pas. En este caso, el módulo y el archivo se denominarán MainUnit o MainModule, y podrá determinar inmediatamente que este es el formulario principal.

Luego viene la conexión de módulos globales. Todos los procedimientos, funciones y constantes se describen en algún módulo y antes de utilizar estos procedimientos es necesario conectarlos. Es posible que sepa que existe una función. Pero para que el compilador sepa esto, debe especificar el módulo donde se describe esta función en un lenguaje comprensible para el compilador. Por ejemplo, necesitas convertir un número en una cadena. Delphi ya tiene la función IntTostr para esto. Se describe en el módulo Sysutils. Si desea utilizar esta función, debe conectar este módulo a su módulo de Formularios (escriba el nombre Sysutils en la sección de usos).

Hay cuatro tipos de particiones:

1. Privado- Las propiedades y métodos de esta sección están disponibles sólo para este objeto. Otros objetos no pueden llamar a estos métodos ni leer/escribir propiedades;
2. Protegido- estas propiedades y métodos están disponibles sólo para este objeto y sus descendientes (objetos que descienden del nuestro y heredan sus propiedades). Los objetos de terceros no pueden acceder a las propiedades y métodos almacenados aquí;
3. Público- todo lo aquí descrito está disponible para todos;
4. Publicado- cuando orinarán componentes propios aplicación, en esta sección describiremos las propiedades y eventos que deben mostrarse en el inspector de objetos. Estas propiedades están disponibles para todos.

Después de la declaración del objeto y sus componentes, hay una descripción de las variables globales. Comienza después de la palabra clave. var y siempre viene después de la declaración de tipos. Debes recordar esto ahora, porque primero viene la sección. tipo, donde se describen los tipos, y luego var, donde se describen las variables.

Las variables globales son variables que se almacenan en la pila, se crean cuando se inicia el programa y se destruyen cuando el programa sale. Esto significa que están disponibles en cualquier momento y en cualquier lugar mientras se ejecuta el programa.

ejemplo de declaración de variable global

Este ejemplo declara una variable, Forml, de tipo TForml. Cuando se crea el objeto TForml, su puntero se escribirá en la variable Form1. Esta variable es global y existe mientras el programa se está ejecutando, lo que significa que siempre se puede acceder a ella.

Palabra clave implementación Tampoco lo tocaremos por ahora, pero lo dejaremos para el futuro, cuando nuestro conocimiento de Delphi se amplíe un poco. Lo último que queda por cubrir en este capítulo es la clave ($R * dfm).

Las llaves pueden contener no solo comentarios, sino también modificadores del compilador. Se diferencian en que se parecen ($Parámetro de letra]. Letra: indica el tipo de clave. En nuestro caso, se utiliza la letra. R. Esta clave indica que necesita incluir el archivo de recursos en en este caso .dfm archivo (archivo con datos sobre objetos visuales) con el mismo nombre que el nombre del módulo. Si el nombre del módulo Unidad principal, entonces necesitas cambiar esta clave a ($R Unidad principal.dfm). Llave R- esta es la única clave que será necesaria por ahora.

Cualquier código de programa en Delphi está entre el principio y el final. Palabra clave comenzar significa el comienzo del código, un fin- fin. Por ejemplo, cuando escribe un procedimiento, primero debe escribir su nombre (hablaremos sobre cómo hacerlo más adelante) y luego encerrar su código entre los corchetes del operador de inicio y fin.

Basado en materiales del sitio.

Página 7 de 12

Clases

Estructura del cuerpo de clase

El cuerpo de la clase, cuando se declara, se sujeta a la siguiente estructura:

• Declaración de campos;
• Declaración de métodos;
• Declaración de propiedades.

Niveles de acceso

• Miembros de clase privados (ocultos) ( privado);
• Miembros de la clase protegida ( protegido);
• Miembros de la clase pública ( público);
• Miembros de la clase publicada ( publicado)

Por lo tanto, en Object Pascal hay cuatro niveles de acceso para los miembros de la clase: publicado, público, protegido y privado, en orden de visibilidad decreciente. De forma predeterminada, el nivel de acceso está publicado. En general, a los miembros del grupo se les debe dar el nivel más bajo de acceso que sea apropiado para ese miembro. Por ejemplo, un miembro al que pueden acceder clases desde el mismo módulo debe tener el nivel de acceso privado. Además, al declarar a los miembros de la clase con nivel más bajo acceso, usted permite que el compilador use características adicionales para optimización. Por otro lado, si planeas generar en el futuro clases infantiles de tu clase, entonces necesitas usar el nivel acceso protegido.

Nunca especifique el nivel de acceso público a los datos. Los datos siempre deben declararse en una sección privada y accederse a ellos mediante métodos o propiedades.

Declaración del constructor

Métodos de declaración