Generación de documentación a través de Code Diary

Este script tiene como objetivo documentar el archivo `project_main.sas^©`. Comienza cargando las macros necesarias (`code_diary.sas^©`, `convert_markdown_to_html.sas^©`). Luego, crea cuatro tablas SAS^© temporales en la biblioteca WORK a través de `datalines` para configurar el comportamiento de la documentación: alias de secciones, orden de visualización, etiquetas de encabezados y palabras clave a ocultar (scrub). Finalmente, ejecuta la macro de documentación y luego la macro de conversión a HTML.

Análisis de datos

Type : CREATION_INTERNE

Los datos de configuración (listas de alias, órdenes, encabezados y filtros) se crean directamente en el script utilizando pasos DATA y la instrucción `datalines`.

1 Bloque de código

INCLUDE

Explicación :
Inclusión de los archivos fuente que contienen las definiciones de las macros `code_diary` y `convert_markdown_to_html`.

¡Copiado!

1	%include "&MACRO_ROOT.code_diary.sas";
2	%include "&MACRO_ROOT.convert_markdown_to_html.sas";
3

2 Bloque de código

DATA STEP Data

Explicación :
Configuración de los parámetros de la documentación mediante la creación de tablas SAS (WORK). Estas tablas definen los alias de las secciones, el orden de clasificación, los títulos personalizados y los elementos a excluir del resultado final.

¡Copiado!

1	DATA work.alias_list;
2	INFILE DATALINES;
3	INPUT short_keyword $1-10 long_keyword $11-50;
4	DATALINES;
5	excl exclusion
6	stat statistics
7	;
8
9	DATA work.order_list;
10	INFILE DATALINES;
11	INPUT keyword $1-20 order_no 21-25;
12	DATALINES;
13	todo -30
14	exclusion -20
15	exclusion.time -19
16	exclusion.person -18
17	methods -10
18	no_keyword 0
19	;
20
21	DATA work.header_list;
22	INFILE DATALINES;
23	INPUT keyword $1-15 header $16-50;
24	DATALINES;
25	exclusion Exclusion criteria
26	person Subjects
27	time Time periods
28	todo Task list
29	;
30
31	DATA work.scrub_list;
32	INFILE DATALINES;
33	INPUT keyword $1-15;
34	DATALINES;
35	todo
36	regex
37	;

3 Bloque de código

MACRO CALL

Explicación :
Ejecución de la macro `%code_diary` para analizar el archivo `project_main.sas` y generar dos archivos Markdown (una versión completa para codificadores y una versión limpia).

¡Copiado!

1	%code_diary(
2	input_main_file = &DEMO_ROOT.project_main.sas,
3	out_dir = &DEMO_ROOT,
4	out_file = OUTPUT-coder.md,
5	out_file_scrubbed = OUTPUT-for-all.md,
6	debug_mode = 0,
7	section_aliases = work.alias_list,
8	section_order = work.order_list,
9	section_headers = work.header_list,
10	sections_scrubbed = work.scrub_list
11	);

4 Bloque de código

MACRO CALL

Explicación :
Llamada a la macro de utilidad para convertir el archivo Markdown limpiado en una página HTML.

¡Copiado!

1	%convert_markdown_to_html(
2	in_file_md = "&DEMO_ROOT.output-for-all.md",
3	out_file_html = "&DEMO_ROOT.output-for-all.htm",
4	debug_mode = 0
5	);

Este material se proporciona "tal cual" por We Are Cas. No hay garantías, expresas o implícitas, en cuanto a la comerciabilidad o idoneidad para un propósito particular con respecto a los materiales o el código contenidos en este documento. We Are Cas no es responsable de los errores en este material tal como existe ahora o existirá, ni We Are Cas proporciona soporte técnico para el mismo.

Retour à la liste