Génération de documentation Code Diary

Ce script configure et exécute le processus de documentation automatique. Il commence par inclure les définitions de macros nécessaires via `%include`. Ensuite, il crée plusieurs tables SAS^© temporaires (`work.alias_list`, `work.order_list`, etc.) contenant les paramètres de configuration (alias, ordre des sections, en-têtes). Enfin, il appelle la macro `%code_diary` pour générer le rapport Markdown et la macro `%convert_markdown_to_html` pour produire la version HTML.

Analyse des données

Type : CREATION_INTERNE

Les données de configuration sont créées directement dans le script via des étapes DATA utilisant DATALINES.

1 Bloc de code

INCLUDE

Explication :
Chargement des bibliothèques de macros situées dans le répertoire défini par la variable macro `&MACRO_ROOT`.

Copié !

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

2 Bloc de code

DATA STEP Data

Explication :
Création des tables de paramétrage (alias, ordre, en-têtes, exclusions) nécessaires au fonctionnement de la macro de documentation.

Copié !

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 Bloc de code

MACRO CALL

Explication :
Exécution de la macro `%code_diary` pour l'analyse du code et la génération du fichier Markdown, suivie de la conversion en HTML via `%convert_markdown_to_html`.

Copié !

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	);

Ce matériel est fourni "tel quel" par We Are Cas. Il n'y a aucune garantie, expresse ou implicite, quant à la qualité marchande ou à l'adéquation à un usage particulier concernant le matériel ou le code contenu dans les présentes. We Are Cas n'est pas responsable des erreurs dans ce matériel tel qu'il existe maintenant ou existera, et We Are Cas ne fournit pas de support technique pour celui-ci.

Retour à la liste