-
Notifications
You must be signed in to change notification settings - Fork 5
/
Rules.xml
3737 lines (3288 loc) · 160 KB
/
Rules.xml
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
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="utf-8"?>
<Rules version="20120223">
<!--
AtomineerUtils Rules
====================
This Xml file provides the default rules for the output that AtomineerUtils generates.
User customisations
===================
You can add custom rules and templates to control the layout of comment blocks and the
auto-doc text that is generated for different code elements.
This file provides the AtomineerUtils defaults. Although you can edit this file directly
to gain extensive control over the formatting and content of the documentation comments
generated by AtomineerUtils, note that when upgrading you will need to merge your changes
into the latest version of Rules.xml, which can be rather tedious.
To alleviate this, AtomineerUtils Pro users can create a new file alongside this one for
each main section of this file (UserVariables, DocXmlTemplates, DoxygenTemplates, and each
of the AutoDoc categories) - For example, "UserVariables.xml" or "Methods.xml", with a
format like the block it customises, e.g.:
<UserVariables>
<Variable name="customVariable" value="123"/>
</UserVariables>
If AtomineerUtils finds such an XML file, it will import it so that the commands it
contains are executed before the defaults in Rules.XML. You can therefore test for
specific conditions that you wish to handle - so for example, if you set a description
with an <If> or <Set> command, it will override the description that AtomineerUtils
would otherwise generate.
Usually these customisation files reside next to Rules.xml, but if you wish to put them
on a network share or source-controlled folder, you can save them anywhere you like and
then add their location(s) to the Prefs.xml file's Misc\RulesPath entry. If multiple
locations are used, simply separate the pathnames with a semicolon.
Layout of this file
===================
The rules are split into the following main sections, each of which contains extensive
documentation indicating how to customise the rules for your own needs:
<UserVariables> When generating doc comment text, AtomineerUtils can replace
variable names such as %user% with context-sensitive text.
This section allows you to add your own variables, such as
%CompanyName%.
<DocXmlTemplates> These sections control the comment output format used for
<DoxygenTemplates> each type of code element that can be documented. You can
specify the order of the entries, add or remove blank lines,
fill in plain-text defaults for entries, and add custom
entries to your comments.
<AutoDoc> This section contains the rules that control the auto-
generation of documentation comments. It contains a
subsection for each code element type (classes, methods,
parameters etc) within which are a number of rules that
control what the is auto generated based on factors such
as the name and type of the entry.
Finally, it includes a <WordExpansion> section that maps
abbreviations like "bmp" or "wnd" to their full form
("bitmap" and "window")
-->
<UserVariables>
<!--
Set any desired user variables in this section.
These can be output in description text or used in subsequent variable definitions using the
%varName% syntax (see below).
When documenting, each type being documented provides a set of useful variables.
In addition the following global variables are always available:
%user% User's login name (or the overridden name provided in the Atomineer Options)
%date% The current date/time, in the format specified in the Atomineer Options
%day% The current day, e.g. "Tuesday"
%dayofmonth% The current day of the month as a number, e.g. "2"
%month% The current month, e.g. "June"
%monthofyear% The current month as a number, e.g. "6"
%year% The current year, e.g. "2009"
%pathname% Full pathname of the current file e.g. "C:\MyProject\Source\MenuHandlers\FileOpen.cpp"
%projectpathname% Pathname of the current file relative to the project folder
(or a full pathname if it's outside the project root), e.g. "Source\MenuHandlers\FileOpen.cpp"
%projectfolder% Project folder containing the current file, e.g. "Source\MenuHandlers"
%folder% Leafname of the folder containing the current file, e.g. "MenuHandlers"
%leafname% Leafname of the current file (not including the file extension) e.g. "FileOpen"
%extension% File extension of the current file (including the ".") e.g. ".cpp"
%project% Name of the Project containing the current file
%containingclass% Name of the class containing the cursor (or the file leafname if intellisense unavailable)
%assemblyname% Assembly name for the Project containing the current file
%assemblyversion% Assembly version
%assemblyfileversion% Assembly file version
%assemblytitle% Assembly title
%assemblydesc% Assembly description
%assemblycompany% Assembly company name
%assemblycopyright% Assembly copyright
%assemblytrademark% Assembly trademark
Note that if you create a variable with the same name as a global, the global will be replaced
by your definition. The type-specific variables (e.g. %retType%) cannot be overridden.
-->
<Variable name="company" ifSet="false" value="MyCompany.com"/>
<Variable name="copyright" ifSet="false" value="Copyright (c) %year% %company%. All rights reserved."/>
<Variable name="useremail" ifSet="false" value="%user%@%company%"/>
<!--
Special variables
For language translations, or simply to adjust the output of AtomineerUtils, fill in the
following variables (and check the rules that use them below):
-->
<Variable name="property-getonly" ifSet="false" value="Gets"/>
<Variable name="property-setonly" ifSet="false" value="Sets"/>
<Variable name="property-getset" ifSet="false" value="Gets or sets"/>
<Variable name="indexer-getonly" ifSet="false" value="get"/>
<Variable name="indexer-setonly" ifSet="false" value="set"/>
<Variable name="indexer-getset" ifSet="false" value="get or set"/>
<!--
Options that control the output of the rules
The options below are:
stylecop - set to true to change AtomineerUtils outputs to be StyleCop-compliant.
docBasesWithSee - set to true to document base classes/interfaces (where possible) as
<see cref="Fully.Qualified.BaseClass"/>
docOverridesWithSee - set to true to document overrides (where possible) as
<see cref="Fully.Qualified.OverrideName(Params)"/> instead of copying base-class
documentation or generating auto-doc text.
(Note that you also need to disable duplication of base documentation in the
preferences to allow these rules to be applied for overrides).
-->
<Variable name="stylecop" ifSet="false" value="false"/>
<Variable name="docBasesWithSee" ifSet="false" value="false"/>
<Variable name="docOverridesWithSee" ifSet="false" value="false"/>
</UserVariables>
<!-- ======================================================================================= -->
<!-- Templates for DocXml comment blocks. See the <DoxygenTemplates> for Doxygen equivalents -->
<DocXmlTemplates>
<!--
Templates for DocXml Comment blocks
===================================
These control which entries are added to the comment, and their order, for each type
of comment block that can be generated by AtomineerUtils.
There are two sets of templates, for DocXml and Doxygen formats respectively.
This block holds the DocXml templates.
The types that can be independently templated are:
file
file-footer
namespace
enum, bitfield
struct, class, interface
method, property, indexer, delegate,
constructor, destructor (c++), finaliser (c#),
operator, eventhandler, eventsender
If no template is supplied for a type, a default AtomineerUtils layout will be used.
AtomineerUtils builds content for the most common entries for you. Use the following empty
Xml elements as markers to indicate where these entries (if non-empty) should be placed in
the comment:
<summary/> <remarks/> <exception/> <param/> <returns/> <value/>.
Remove or comment out any element to suppress it in the doc-comment.
Note that <param/> is a placeholder for any parameters or generic/template type parameters, and
can be used for classes and interfaces as well as methods.
The special element <_/> adds a blank line between entries (note that using this tag
*within* an entry simply adds "<_>" to the output comment. Instead, use newlines in an
entry to add newlines to the output comment - but note that these may still be removed
by the word wrap feature). Multiple blank lines will be merged.
Any element containing attributes (other than the special ones listed below) or content
will be simply copied into the doc comment, allowing you to add custom tags or override
the output of the auto-generated text provided by AtomineerUtils.
Variables
=========
Variables (see below) can be included with the %varName% syntax.
Special attributes
==================
Special attributes can be added to control the output of each element individually:
_wordwrap="true" true = (default) If the word wrapping preference is enabled
word-wrap the text in this element.
false = Ignore the preference and disable word-wrap in this
element.
_punctuate="true" true = (default) Add punctuation at the end of the element
if it does not appear to end in punctuation.
false = Do not add any additional punctuation.
_verbatim="true" true = Copy the text from this element verbatim (no word
wrap, no punctuation, no header on each line, etc)
false = (default) Format the text from this element, using
line headers and word wrap as configured.
_optional="false" true = This entry is "legal", and should be formatted to
the given position in the final doc comment, but
should not be added by AtomineerUtils if it is
missing.
false = (default) This entry should be added by
AtomineerUtils if it is not present.
_blankEntry="text" In the case of auto-generated entries such as param and
exception, the standard is to have no entries if there are
no params/exceptions to document. However, some companies
require that an entry is retained, as in <param>None</param>
If you specify a _blankEntry, this text will be used to
create an entry in these circumstances.
Hint: Adding "TODO" items to the Visual Studio Task List window
===============================================================
You can add TODO, HACK, UNDONE entries to be displayed automatically in the Visual
Studio Task Window. However, there are some limitations:
C#:
Visual Studio doesn't recognise task comments that directly follow an XML start
tag, so you must place the TODO on a blank line:
<remarks>
TODO: Don't forget to fill in the remarks!
</remarks>
C++:
Visual Studio completely ignores task comments inside DocXml /// blocks.
You must use the _verbatim="true" tag to emit a normal comment into the
DocXml block:
<remarks _verbatim="true">
// TODO: Don't forget to fill in the remarks!
</remarks>
Examples
========
<summary> Place the summary first, using AtomineerUtils-generated content
<remarks> No comment </remarks> Place remarks next, containing the text "No comment"
<_/> Add a blank line
<info author="%user%"/> Add entry: <info author="Jason Williams"/>
<author> %user% </author> Add entry: <author> Jason Williams </author>
Note:
The file template is different from regular comment blocks because you aren't documenting
a code element. AtomineerUtils offers two options:
1) If this template includes any embedded XML elements, it will be treated as a regular
XML Documentation comment, and will thus take on the separators and other style
configured for your comments.
2) If there are no embedded XML elements, this template is treated as a block of freeform
text - WYSIWYG.
In both cases, you can insert any global variables or the following special variables:
%fileDesc% Description of this file as generated by the <File> autodoc rules below.
-->
<!-- StyleCop-compatible Xml-based file header.
Note that this uses < and > so that it will be treated as plain text rather than XML
-->
<file stylecop="true">
// <copyright file="%leafname%%extension%" company="%company%">
// Copyright (c) %year% All Rights Reserved
// </copyright>
// <author>%user%</author>
// <date>%date%</date>
// <summary>%fileDescription%</summary>
</file>
<!-- Catch-all plain-text AtomineerUtils headers. See below for other examples -->
<file>
// file: %projectpathname%
//
// summary: %fileDescription%
</file>
<file-vb _separators="false">
'---------------------------------------------------------------------------------------------------
' file: %projectpathname%
'
' summary: %fileDescription%
'---------------------------------------------------------------------------------------------------
</file-vb>
<!-- Special header and footer pair for .h and .hpp files, which will automatically add an
include-once mechanism to the file.
<file _filetypes=".h.hpp" _addfooter="true" _separators="false">
// file: %projectpathname%
//
// summary: %fileDescription%
#ifndef INC_%leafname%_H
#define INC_%leafname%_H
</file>
<filefooter filetypes=".h.hpp" _separators="false">
// end of %projectpathname%
#endif // INC_%leafname%_H
</filefooter>
-->
<!-- Free-form text file header example
<file>
// project: %project%
// file: %projectpathname%
//
// summary: %fileDescription%
//
// %copyright%
//
// Date Developer Change
// %date% %user% Created
</file>
-->
<!-- XML comment example
<file>
<prototype>%projectpathname%</prototype>
<_/>
<summary/>
</file>
-->
<!-- Catch-all plain-text file footers. These follow the same form as the file headers above -->
<filefooter>
// End of %projectpathname%
</filefooter>
<filefooter-vb _separators="false">
'---------------------------------------------------------------------------------------------------
' End of %projectpathname%
</filefooter-vb>
<!--
Comment template for catch-all comments. These are added when the filetype of the document
is not one of the core languages that AtomineerUtils can parse to auto-document. The
separators and line headers used for each file extension (e.g. .html, .sql) are configured
in your Prefs.xml, allowing AtomineerUtils to correctly insert simple "boilerplate" comments
into any file format.
-->
<catchall>
<summary/>
<_/>
<remarks>%user%, %date%</remarks>
</catchall>
<!--
Default namespace comment. As with file comments, you can use plain-text or XML commenting for
this entry.
-->
<namespace>
// namespace: %name%
//
// summary: %namespaceDescription%
</namespace>
<!-- Example XML namespace comment.
<namespace>
<prototype/>
<_/>
<summary/>
</namespace>
-->
<typedef>
<summary/>
<_/>
<remarks>%user%, %date%</remarks>
<_/>
<seealso _punctuate="false" _optional="true"/>
</typedef>
<enum>
<summary/>
<_/>
<remarks>%user%, %date%</remarks>
<_/>
<seealso _punctuate="false" _optional="true"/>
</enum>
<bitfield>
<summary/>
<_/>
<remarks>%user%, %date%</remarks>
<_/>
<seealso _punctuate="false" _optional="true"/>
</bitfield>
<struct>
<summary/>
<_/>
<remarks>%user%, %date%</remarks>
<_/>
<example _punctuate="false" _optional="true"/>
<_/>
<seealso _punctuate="false" _optional="true"/>
</struct>
<union>
<summary/>
<_/>
<remarks>%user%, %date%</remarks>
<_/>
<example _punctuate="false" _optional="true"/>
<_/>
<seealso _punctuate="false" _optional="true"/>
</union>
<class>
<summary/>
<_/>
<remarks>%user%, %date%</remarks>
<_/>
<param/>
<_/>
<example _punctuate="false" _optional="true"/>
<_/>
<seealso _punctuate="false" _optional="true"/>
</class>
<interface>
<summary/>
<_/>
<remarks>%user%, %date%</remarks>
<_/>
<param/>
<_/>
<example _punctuate="false" _optional="true"/>
<_/>
<seealso _punctuate="false" _optional="true"/>
</interface>
<def> <!-- C/C++ #define macro -->
<summary/>
<_/>
<remarks>%user%, %date%</remarks>
<_/>
<param/>
<_/>
<example _punctuate="false" _optional="true"/>
<_/>
<seealso _punctuate="false" _optional="true"/>
</def>
<method>
<summary/>
<_/>
<remarks>%user%, %date%</remarks>
<_/>
<exception/>
<_/>
<param/>
<_/>
<returns/>
<_/>
<example _punctuate="false" _optional="true"/>
<_/>
<seealso _punctuate="false" _optional="true"/>
</method>
<property>
<summary/>
<_/>
<remarks _optional="true"/>
<_/>
<value/>
<_/>
<seealso _punctuate="false" _optional="true"/>
</property>
<indexer>
<summary/>
<_/>
<remarks _optional="true"/>
<_/>
<param/>
<_/>
<value/>
<_/>
<seealso _punctuate="false" _optional="true"/>
</indexer>
<delegate>
<summary/>
<_/>
<remarks>%user%, %date%</remarks>
<_/>
<exception/>
<_/>
<param/>
<_/>
<returns/>
<_/>
<seealso _punctuate="false" _optional="true"/>
</delegate>
<constructor>
<summary/>
<_/>
<remarks>%user%, %date%</remarks>
<_/>
<exception/>
<_/>
<param/>
</constructor>
<destructor>
<summary/>
<_/>
<remarks>%user%, %date%</remarks>
<_/>
<exception/>
<_/>
<param/>
</destructor>
<finaliser>
<summary/>
<_/>
<remarks>%user%, %date%</remarks>
<_/>
<exception/>
<_/>
<param/>
</finaliser>
<operator>
<summary/>
<_/>
<remarks>%user%, %date%</remarks>
<_/>
<exception/>
<_/>
<param/>
<_/>
<returns/>
</operator>
<eventhandler>
<summary/>
<_/>
<remarks>%user%, %date%</remarks>
<_/>
<exception/>
<_/>
<param/>
<_/>
<returns/>
<_/>
<seealso _punctuate="false" _optional="true"/>
</eventhandler>
<eventsender>
<summary/>
<_/>
<remarks>%user%, %date%</remarks>
<_/>
<exception/>
<_/>
<param/>
<_/>
<returns/>
<_/>
<seealso _punctuate="false" _optional="true"/>
</eventsender>
<!-- Template for member variables -->
<member>
<summary/>
</member>
<!-- Templates for methods in abstract classes and interfaces -->
<interfacemethod>
<summary/>
<_/>
<remarks _optional="true"/>
<_/>
<param/>
<_/>
<returns/>
<_/>
<example _punctuate="false" _optional="true"/>
<_/>
<seealso _punctuate="false" _optional="true"/>
</interfacemethod>
<interfaceproperty>
<summary/>
<_/>
<remarks _optional="true"/>
<_/>
<value/>
<_/>
<example _punctuate="false" _optional="true"/>
<_/>
<seealso _punctuate="false" _optional="true"/>
</interfaceproperty>
<interfaceindexer>
<summary/>
<_/>
<remarks _optional="true"/>
<_/>
<param/>
<_/>
<value/>
<_/>
<example _punctuate="false" _optional="true"/>
<_/>
<seealso _punctuate="false" _optional="true"/>
</interfaceindexer>
</DocXmlTemplates>
<!-- ====================================================================================== -->
<!-- Templates for Doxygen comment blocks. See the <DocXmlTemplates> for DocXml equivalents -->
<DoxygenTemplates>
<!--
Templates for Doxygen Comment blocks
====================================
These control which entries are added to the comment, and their order, for each type
of comment block that can be generated by AtomineerUtils.
There are two sets of templates, for DocXml and Doxygen formats respectively.
This block holds the Doxygen templates.
The types that can be independently templated are:
file
file-footer
namespace
enum, bitfield
struct, class, interface
method, property, indexer, delegate, constructor, destructor (c++), finaliser (c#), operator, eventhandler, eventsender
If no template is supplied for a type, a default AtomineerUtils layout will be used.
AtomineerUtils builds content for the most common entries for you. Use the following empty
Xml elements as markers to indicate where these entries (if non-empty) should be placed in
the comment:
<prototype/> <summary/> <date/> <user/> <exception/> <param/> <returns/> <value/>.
Note that for compatibility with DocXml templates, the following names are used when
actually referring to Doxygen commands/entries:
<prototype/> the prototype command for the code element (\fn, \enum, \class, \struct, etc)
<summary/> the \brief entry
Remove or comment out any element to suppress it in the doc-comment.
Note that <param/> is a placeholder for any parameters or generic/template type parameters, and
can be used for classes and interfaces as well as methods.
The special element <_/> adds a blank line between entries (note that using this tag
*within* an entry simply adds "<_>" to the output comment. Instead, use newlines in an
entry to add newlines to the output comment - but note that these may still be removed
by the word wrap feature). Multiple blank lines will be merged.
Any element containing attributes (other than the special ones listed below) or content
will be simply copied into the doc comment, allowing you to add custom tags or override
the output of the auto-generated text provided by AtomineerUtils.
Variables
=========
Variables (see below) can be included with the %varName% syntax.
Special attributes
==================
Special attributes can be added to control the output of each element individually:
_wordwrap="true" true = (default) If the word wrapping preference is enabled
word-wrap the text in this element.
false = Ignore the preference and disable word-wrap in this
element.
_punctuate="true" true = (default) Add punctuation at the end of the element
if it does not appear to end in punctuation.
false = Do not add any additional punctuation.
_verbatim="true" true = Copy the text from this element verbatim (no word
wrap, no punctuation, no header on each line, etc)
false = (default) Format the text from this element, using
line headers and word wrap as configured.
_optional="false" true = This entry is "legal", and should be formatted to
the given position in the final doc comment, but
should not be added by AtomineerUtils if it is
missing.
false = (default) This entry should be added by
AtomineerUtils if it is not present.
_blankEntry="text" In the case of auto-generated entries such as param, returns
and exception, the standard is to have no entries if there are
no params/exceptions to document. However, some companies
require that an entry is retained, as in <param>None</param>
If you specify a _blankEntry, this text will be used to
create an entry in these circumstances.
Hint: Adding "TODO" items to the Visual Studio Task List window
===============================================================
You can add TODO, HACK, UNDONE entries to be displayed automatically in the Visual
Studio Task Window. However, there are some limitations:
C#:
Visual Studio doesn't recognise task comments that directly follow an XML start
tag, so you must place the TODO on a blank line:
<remarks>
TODO: Don't forget to fill in the remarks!
</remarks>
C++:
Visual Studio completely ignores task comments inside DocXml /// blocks.
You must use the _verbatim="true" tag to emit a normal comment into the
DocXml block:
<remarks _verbatim="true">
// TODO: Don't forget to fill in the remarks!
</remarks>
Examples
========
<summary> Place the summary first, using AtomineerUtils-generated content
<remarks> No comment </remarks> Place remarks next, containing the text "No comment"
<_/> Add a blank line
<info author="%user%"/> Add entry: <info author="Jason Williams"/>
<author> %user% </author> Add entry: <author> Jason Williams </author>
Note:
The file template is different from regular comment blocks because you aren't documenting
a code element. AtomineerUtils offers two options:
1) If this template includes any embedded XML elements, it will be treated as a regular
XML Documentation comment, and will thus take on the separators and other style
configured for your comments.
2) If there are no embedded XML elements, this template is treated as a block of freeform
text - WYSIWYG.
In both cases, you can insert any global variables or the following special variables:
%fileDesc% Description of this file as generated by the <File> autodoc rules below.
-->
<!-- Special header and footer pair for .h and .hpp files, which will automatically add an
include-once mechanism to the file.
<file _filetypes=".h.hpp" _addfooter="true" _separators="false">
// file: %projectpathname%
//
// summary: %fileDescription%
#ifndef INC_%leafname%_H
#define INC_%leafname%_H
</file>
<filefooter filetypes=".h.hpp" _separators="false">
// end of %projectpathname%
#endif // INC_%leafname%_H
</filefooter>
-->
<file>
<prototype _punctuate="false">%projectpathname%</prototype>
<_/>
<summary/>
</file>
<file-vb _separators="false">
<prototype _punctuate="false">%projectpathname%</prototype>
<_/>
<summary/>
</file-vb>
<!-- Free-form text example
<file>
// project: %project%
// file: %projectpathname%
//
// summary: %fileDescription%
//
// %copyright%
//
// Date Developer Change
// %date% %user% Created
</file>
-->
<!-- Default plain-text AtomineerUtils file footer. These follow the same form as the file headers above -->
<filefooter>
// End of %projectpathname%
</filefooter>
<filefooter-vb _separators="false">
'---------------------------------------------------------------------------------------------------
' End of %projectpathname%
</filefooter-vb>
<!--
Comment template for catch-all comments. These are added when the filetype of the document
is not one of the core languages that AtomineerUtils can parse to auto-document. The
separators and line headers used for each file extension (e.g. .html, .sql) are configured
in your Prefs.xml, allowing AtomineerUtils to correctly insert simple "boilerplate" comments
into any file format.
-->
<catchall>
<summary/>
<_/>
<author _punctuate="false">%user%</author>
<date _punctuate="false">%date%</date>
<_/>
<sa _punctuate="false" _optional="true"/>
</catchall>
<!--
Default namespace comment. As with file comments, you can use plain-text or XML commenting for
this entry.
-->
<namespace>
<prototype _punctuate="false"/>
<_/>
<summary/>
<_/>
<sa _punctuate="false" _optional="true"/>
</namespace>
<typedef>
<prototype _punctuate="false"/>
<_/>
<summary/>
<_/>
<sa _punctuate="false" _optional="true"/>
</typedef>
<enum>
<prototype _punctuate="false"/>
<_/>
<summary/>
<_/>
<sa _punctuate="false" _optional="true"/>
</enum>
<bitfield>
<prototype _punctuate="false"/>
<_/>
<summary/>
<_/>
<sa _punctuate="false" _optional="true"/>
</bitfield>
<struct>
<prototype _punctuate="false"/>
<_/>
<summary/>
<_/>
<author _punctuate="false">%user%</author>
<date _punctuate="false">%date%</date>
<_/>
<sa _punctuate="false" _optional="true"/>
</struct>
<union>
<prototype _punctuate="false"/>
<_/>
<summary/>
<_/>
<author _punctuate="false">%user%</author>
<date _punctuate="false">%date%</date>
<_/>
<sa _punctuate="false" _optional="true"/>
</union>
<class>
<prototype _punctuate="false"/>
<_/>
<summary/>
<_/>
<author _punctuate="false">%user%</author>
<date _punctuate="false">%date%</date>
<_/>
<param/>
<_/>
<sa _punctuate="false" _optional="true"/>
</class>
<interface>
<prototype _punctuate="false"/>
<_/>
<summary/>
<_/>
<author _punctuate="false">%user%</author>
<date _punctuate="false">%date%</date>
<_/>
<param/>
<_/>
<sa _punctuate="false" _optional="true"/>
</interface>
<def> <!-- C/C++ #define macro -->
<prototype _punctuate="false"/>
<_/>
<summary/>
<_/>
<author _punctuate="false">%user%</author>
<date _punctuate="false">%date%</date>
<_/>
<param/>
<_/>
<sa _punctuate="false" _optional="true"/>
</def>
<method>
<prototype _punctuate="false"/>
<_/>
<summary/>
<_/>
<author _punctuate="false">%user%</author>
<date _punctuate="false">%date%</date>
<_/>
<exception/>
<_/>
<param/>
<_/>
<returns/>
<_/>
<sa _punctuate="false" _optional="true"/>
</method>
<property>
<prototype _punctuate="false"/>
<_/>
<summary/>
<_/>
<value/>
<_/>
<sa _punctuate="false" _optional="true"/>
</property>
<indexer>
<prototype _punctuate="false"/>
<_/>
<summary/>
<_/>
<param/>
<_/>
<value/>
<_/>
<sa _punctuate="false" _optional="true"/>
</indexer>
<delegate>
<prototype _punctuate="false"/>
<_/>
<summary/>
<_/>
<author _punctuate="false">%user%</author>
<date _punctuate="false">%date%</date>
<_/>
<exception/>
<_/>
<param/>
<_/>
<returns/>
<_/>
<sa _punctuate="false" _optional="true"/>
</delegate>
<constructor>
<prototype _punctuate="false"/>
<_/>
<summary/>
<_/>
<author _punctuate="false">%user%</author>
<date _punctuate="false">%date%</date>
<_/>
<exception/>
<_/>
<param/>
<_/>
<sa _punctuate="false" _optional="true"/>
</constructor>
<destructor>
<prototype _punctuate="false"/>
<_/>
<summary/>
<_/>
<author _punctuate="false">%user%</author>
<date _punctuate="false">%date%</date>
<_/>
<exception/>
<_/>
<param/>
<_/>
<sa _punctuate="false" _optional="true"/>
</destructor>
<finaliser>
<prototype _punctuate="false"/>
<_/>
<summary/>
<_/>
<author _punctuate="false">%user%</author>