-
Notifications
You must be signed in to change notification settings - Fork 15
/
AUTODOC.txt
607 lines (498 loc) · 20.1 KB
/
AUTODOC.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
ТЕХНИЧЕСКОЕ ЗАДАНИЕ
Алгоритм автоматического
составления документации к модулю
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Поставляемая с компилятором программа для автоматического создания
документации к проекту работает с исходным кодом модулей проекта и
предполагает специальное оформление комментариев в исходном коде.
Комментарии, попадающие в документацию будем называть спецкомментариями.
Спецкомментарии начинаются со скобки, за которой идёт ровно две звёздочки:
Пример:
CONST strLen = 256; (** Это пойдёт в документацию *)
Система производит частичный синтаксический анализ исходного кода модуля и
улавливает находяющуюся в нём информацию об экспортированных объектах, а также
спецкомментарии к ним. Полученные данные сохраняются в древовдиной динамической
структуре данных. Эта структура данных затем может использоваться для вывода
документации к модулю в виде текста, двоичном виде или в формате HTML.
Для примера будет использован модуль Apples, текст которого приведён ниже:
(** Module Apples helps count apples.
One can create a variable of type Apples.Apple,
call Init and other procedures on it. *)
MODULE Apples;
(** Это тестовый модуль. *)
IMPORT Out, Fruits;
CONST
(** Общие постоянные **)
maxApples* = 5; (** Maximum amount of apples. Currently unused *)
maxSeeds* = 10; (** Currently not in use *)
startApples = 0; (** Start amount of apples. Used in Reset *)
(** Качество яблока **)
unknown* = 0; (** Неизвестное качество *)
good* = 1; (** Сносное качество *)
bad* = 2; (** Отвратное качество *)
TYPE
(** Тип яблоко *)
Apple* = RECORD(Fruits.Fruit) (** Represents an apple with some seeds *)
seeds*: INTEGER; (** Amount of seeds in the apple *)
quality*: INTEGER; (** Качество продукта, см. @Качество яблока *)
added: BOOLEAN (** Whether Add was called on this seed after Init *)
END;
VAR
applesCreated*: INTEGER; (** How many apples were created using Init *)
(** If FALSE, Show shows a welcome message and sets shown to TRUE *)
shown: BOOLEAN;
lastAdded*: INTEGER; (** How many seeds were added the last time, or -1 *)
(** Sets the given amount of seeds to apple a. *)
PROCEDURE Set(VAR a: Apple; seeds: INTEGER);
BEGIN
a.seeds := seeds;
IF seeds >= 3 THEN a.quality := good
ELSIF seeds = 0 THEN a.quality := bad
ELSE a.quality := unknown
END
END Set;
PROCEDURE Init*(VAR a: Apple; seeds: INTEGER);
(** Initializes apple a with the specified amount of seeds. *)
BEGIN
INC(applesCreated);
Set(a, seeds);
a.added := FALSE
END Init;
(** Apple manipulation **)
(** Adds n seeds to apple a. *)
PROCEDURE Add*(VAR a: Apple; n: INTEGER);
BEGIN
lastAdded := n;
Set(a, a.seeds + n);
a.added := TRUE
END Add;
PROCEDURE Show*(a: Apple);
(** Dispalys a message about the apple. *)
BEGIN
IF ~shown THEN
Out.String('Welcome to Apples!');
Out.Ln;
shown := TRUE
END;
IF a.added THEN
Out.String('Added apple with ')
ELSE
Out.String('Apple with ')
END;
Out.Int(a.seeds, 0);
Out.String(' seeds.');
Out.Ln
END Show;
(** - **)
(** Resets internal apple counter. *)
PROCEDURE Reset*;
BEGIN
lastAdded := -1;
applesCreated := startApples;
shown := FALSE
END Reset;
PROCEDURE Shown*(): BOOLEAN; RETURN shown END Shown; (** Было ли приветствие *)
BEGIN
Reset
END Apples.
Принципы работы алгоритма автоматического
составления документации к модулю
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. Учитываются только экспортированные объекты.
2. Модуль учитыватеся в любом случае.
3. Учитываются только комментарии с двумя звёздочками в начале (** ... *)
4. Если комментарий имеет две звёздочки в конце (** ... **), это запоминается.
5. Есть 7 типов объектов:
модуль (он один), константы, типы, переменные, процедуры, параметры,
переменные. К последним относятся также и поля записей.
6. Пробельные литеры между словами комментария замещаются единичным пробелом.
(** Hello world
Comment *) ---> 'Hello world Comment'
7. Если среди пробельных литер есть два переноса строки, выполняется перенос.
(** Hello world
Comment *) ---> 'Hello world[0AX]Comment'
8. Если строчки комментария имеют больший отступ, чем та величина, на которую
отстоит от начала строки первая буква комментария, то эти пробелы лишние
сохраняются, а вместе с ними и переносы до и после указанных строк.
(** This is my comment (** This is my comment
With a normal indent. *) Also with a normal indent. *)
---> 'This is my comment With a normal indent.'
(** This is my comment
With a bigger indent.
And a normal continuation. *) --->
'This is my comment[0AX]' +
' With a bigger indent.[0AX]' +
'And a normal continuation.'
9. Все комментарии, кроме заголовков, автоматически дополняются точкой
в конце, если они не заканчиваются на одну из литер '!,.:;?'.
10. Каждый считанный комментарий прикрепляется к ближайшему к нему объекту или,
в случае обладания двумя звёздочками в конце, образует комментарий группы
объектов (заголовок).
11. Есть 4 вида прикрепления комментариев к объектам:
а) К следующему объекту.
(** Модуль для яблок. *)
MODULE Apples;
TYPE
(** Тип яблоко *)
Apple* = RECORD END;
б) К предыдущему объекту.
CONST
good* = 1; (** Сносное качество *)
в) К следующей группе объектов (заголовок).
CONST
(** Общие постоянные **)
maxApples* = 5;
maxSeeds* = 10;
г) Комментарий находится внутри объекта.
MODULE Apples;
(** Это тестовый модуль. *)
IMPORT Out;
Apple* = RECORD (** Это комментарий должен быть на той же строке. *)
PROCEDURE Init*(VAR a: Apple; seeds: INTEGER);
(** Initializes apple a with the specified amount of seeds. *)
BEGIN
В случае, если есть два комментария к одному и тому же объекту -
один перед и один внутри объекта, - они соединяются через перенос.
11а. Нюанс. В первом примере ниже первый комментарий после заголовка "Цвета"
относится к соответствующей группе объектов, а комментарий "Чёрный"
относится к следующему за ним объекту black. На это влияет ничто иное
как вертикальный отступ, то есть расстановка переносов строк.
CONST CONST
(** Цвета **) (** Цвета **)
(** Кодировка в 4 бита *)
(** Чёрный цвет *)
(** Чёрный *) black* = 0; (** Довольно тёмный *)
black* = 0;
CONST
(** Красный *) (** Цвета **)
black* = 0; (** Кодировка в 4 бита *)
black* = 0; (** Чёрный *)
12. Для каждого типа объекта сохраняется дополнительная информация о нём:
Для модуля - название и импортированные модули, на которые есть ссылки
(при определении типов, переменных или параметров),
Для константы - имя и значение,
Для типа - имя и определение,
Для переменной - имя и тип,
Для процедуры - имя, список параметров и тип возвращаемого значения,
Для записи - список полей,
Для поля - имя и тип,
Для параметра - имя, тип и способ передачи (по значению, VAR, IN, OUT).
13. Комментарии к группам объектов (заголовки) работают следующим образом:
1) В рамках каждого вида объектов есть группы.
2) Если группы не обозначены комментариями (нет заголовков) или часть
объектов не входит ни в одну группу (не озагававлена), они заносятся
в общую группу (в рамках каждого вида объектов).
3) Объекты сортируются в алфавитном порядке внутри каждой группы. Но
если группа целиком состоит из различных числовых или литерных
постоянных, то сортировка не происходит и сохраняется исходный порядок.
null = 0; apple = 1; pineapple = 2; other = 3;
4) Комментарий-заголовок, в котором находится только знак минус приводит
к тому, что идущие за ним объекты относятся к безымянной группе.
(** - **) (**-**) (** - **)
ПРИМЕР ГЕНЕРИРУЕМОЙ
СТРУКТУРЫ ДАННЫХ ДОКУМЕНТАЦИИ
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Используется произвольный наглядный формат с указанием типов данных (записей).
Помета "next ->" означает, что записи связаны в связной список. Предполагается,
что тип List обладает возможностью хранить связные списки различных типов:
Const, Var, Procedure, Type или Group.
Module {
name = 'Apples'
foreign = FALSE
comment = 'Module Apples helps count apples. One can create ' +
'a variable of type Apples.Apple, call Init and other ' +
'procedures on it. Это тестовый модуль.'
imports = ['Fruits']
consts = List {
Group {
comment = 'Общие постоянные'
body = Objects {
Const {
comment = 'Maximum amount of apples. Currently not used.'
name = 'maxApples'
value = '5'
}
Const {
comment = 'Currently not in use.'
name = 'maxSeeds'
value = '10'
}
}
} next ->
Group {
comment = 'Качество яблока'
body = List {
Const {
comment = 'Неизвестное качество.'
name = 'unknown'
value = '0'
}
Const {
comment = 'Сносное качество.'
name = 'good'
value = '1'
}
Const {
comment = 'Отвратное качество.'
name = 'bad'
value = '2'
}
}
}
}
types = List {
Group {
comment = ''
body = List {
Type {
comment = 'Тип яблоко.[0AX]Represents an apple with some seeds.'
name = 'Apple'
form = recordType
base = 'Fruits.Fruit'
fields = List {
Field {
comment = 'Amount of seeds in the apple.'
name = 'seeds'
type = Type {
name = 'INTEGER'
form = namedType
}
} next ->
Field {
comment = 'Качество продукта, см. @Качество яблока.'
name = 'quality'
type = Type {
name = 'INTEGER'
form = namedType
}
}
}
}
}
}
}
vars = List {
Group {
comment = ''
body = List {
Var {
name = 'applesCreated'
comment = 'How many apples were created using Init.'
type = Type {
name = 'INTEGER'
form = namedType
}
}
Var {
name = 'lastAdded'
comment = 'How many seeds were added the last time, or -1.'
type = Type {
name = 'INTEGER'
form = namedType
}
}
}
}
}
procedures = List {
Group {
comment = ''
body = List {
Procedure {
name = 'Init'
comment = 'Initializes apple a with the specified amount of seeds.'
returnType = NIL
params = List {
Param {
name = 'a'
pass = byVar
type = Type {
name = 'Apple'
form = namedType
}
} next ->
Param {
name = 'seeds'
pass = byValue
type = Type {
name = 'INTEGER'
form = namedType
}
}
}
} next ->
Procedure {
name = 'Reset'
comment = 'Resets internal apple counter.'
returnType = NIL
params = List { NIL }
} next ->
Procedure {
name = 'Shown'
comment = 'Было ли приветствие.'
returnType = Type {
name = 'BOOLEAN'
form = namedType
}
params = List { NIL }
}
}
}
Group {
comment = 'Apple manipulation'
body = List {
Procedure {
name = 'Add'
comment = 'Adds n seeds to apple a.'
returnType = NIL
params = List {
Param {
name = 'a'
pass = byVar
type = Type {
name = 'Apple'
form = namedType
}
} next ->
Param {
name = 'n'
pass = byValue
type = Type {
name = 'INTEGER'
form = namedType
}
}
}
} next ->
Procedure {
name = 'Show'
comment = 'Dispalys a message about the apple.'
returnType = NIL
params = List {
Param {
name = 'a'
pass = byValue
type = Type {
name = 'Apple'
form = namedType
}
}
}
}
}
}
}
}
ПРИМЕР ПРЕДСТАВЛЕНИЯ ДОКУМЕНТАЦИИ
МОДУЛЬ Apples
ОПИСАНИЕ
Module Apples helps count apples. One can create a variable of type
Apples.Apple, call Init and other procedures on it. Это тестовый модуль.
ИНТЕРФЕЙС
DEFINITION Apples;
IMPORT
Fruits;
CONST
bad = 2;
good = 1;
maxApples = 5;
maxSeeds = 10;
unknown = 0;
TYPE
Apple = RECORD (Fruits.Fruit)
seeds, quality: INTEGER
END;
VAR
applesCreated: INTEGER;
lastAdded: INTEGER;
PROCEDURE Add (VAR a: Apple; n: INTEGER);
PROCEDURE Init (VAR a: Apple; seeds: INTEGER);
PROCEDURE Reset;
PROCEDURE Show (a: Apple);
PROCEDURE Shown (): BOOLEAN;
END Apples.
ИМПОРТ
* Fruits
ПОСТОЯННЫЕ
### Общие постоянные ###
* maxApples = 5
Maximum amount of apples. Currently unused.
* maxSeeds = 10
Currently not in use.
### Качество яблока ###
* unknown = 0
Неизвестное качество.
* good = 1
Сносное качество.
* bad = 2
Отвратное качество.
ТИПЫ
Тип Apple
Apple = RECORD(Fruits.Fruit)
seeds: INTEGER; (* Amount of seeds in the apple *)
quality: INTEGER (* Качество продукта, см. @Качество яблока *)
END;
Тип яблоко. Represents an apple with some seeds.
ПЕРЕМЕННЫЕ
* applesCreated: INTEGER;
How many apples were created using Init.
* lastAdded: INTEGER;
How many seeds were added the last time, or -1.
ПРОЦЕДУРЫ
### Apple manipulation ###
* PROCEDURE Add*(VAR a: Apple; n: INTEGER);
Adds n seeds to apple a.
* PROCEDURE Show*(a: Apple);
Dispalys a message about the apple.
### Другие процедуры ###
* PROCEDURE Init(VAR a: Apple; seeds: INTEGER);
Initializes apple a with the specified amount of seeds.
* PROCEDURE Reset*;
Resets internal apple counter.
* PROCEDURE Shown*(): BOOLEAN;
Было ли приветствие
ПРЕДСТАВЛЕНИЕ ДАННЫХ О РАЗЛИЧНЫХ ТИПАХ В ПАМЯТИ
Общие поля типа любой формы:
Type {
comment = ...
name = ...
form = ...
}
Непосредственно объявленный записной тип (RECORD):
Type {
...
form = recordType
base = ...
fields = List { ... }
}
Базовый тип (INTEGER, BOOLEAN, CHAR и т. д.)
Type {
...
form = namedType
name = 'INTEGER' (или другое)
}
Любой заранее объявленный именованный тип:
Type {
...
form = namedType
name = 'Fruits.Fruit' (или другое)
}
Непосредственно объявленный тип-массив (ARRAY):
Type {
...
form = arrayType
len = 10 (-1 для открытых массивов)
base = Type { ... }
}
Непосредственно объявленный указательный тип (POINTER):
Type {
...
form = pointerType
base = Type { ... }
}
Непосредственно объявленный процедурный тип:
Type {
...
form = procedureType
procedure = Procedure { ... }
}