Generación de documentación Code Diary

Este programa configura el entorno para la ejecución de la macro `%code_diary`. Define varias tablas de parámetros (alias, orden, encabezados, exclusiones) a través de pasos DATA y `datalines`. Luego, ejecuta la macro `%code_diary` para analizar un archivo de proyecto principal (`project_main.sas^©`) y producir archivos Markdown (completo y filtrado). Finalmente, convierte el archivo Markdown filtrado a HTML a través de la macro `%convert_markdown_to_html`.

Análisis de datos

Type : CREATION_INTERNE

Las tablas de configuración (alias_list, order_list, header_list, scrub_list) se crean directamente en el script utilizando la instrucción `datalines`. Las rutas de los archivos se gestionan a través de macrovariables (`&MACRO_ROOT`, `&DEMO_ROOT`).

1 Bloque de código

MACRO

Explicación :
Inclusión de las definiciones de las macros externas necesarias para el procesamiento: `code_diary` para la generación del diario y `convert_markdown_to_html` para la conversión de formato.

¡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 :
Creación de cuatro tablas temporales (`work.alias_list`, `work.order_list`, `work.header_list`, `work.scrub_list`) que contienen los parámetros de configuración para la documentación (alias, orden de las secciones, etiquetas de los encabezados y elementos a ocultar).

¡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

Explicación :
Ejecución de las macros principales: `%code_diary` genera los archivos Markdown (uno para desarrolladores, uno 'depurado' para todos) utilizando las tablas de configuración creadas previamente. Luego, `%convert_markdown_to_html` transforma el archivo Markdown depurado en una página HTML.

¡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	);
12
13	%convert_markdown_to_html(
14	in_file_md = "&DEMO_ROOT.output-for-all.md",
15	out_file_html = "&DEMO_ROOT.output-for-all.htm",
16	debug_mode = 0
17	);

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