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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!--Converted with LaTeX2HTML 2002-2-1 (1.70)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Comments and Doc-Comments</TITLE>
<META NAME="description" CONTENT="Comments and Doc-Comments">
<META NAME="keywords" CONTENT="users_guide">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2002-2-1">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="users_guide.css">
<LINK REL="next" HREF="node52.html">
<LINK REL="previous" HREF="node50.html">
<LINK REL="up" HREF="node49.html">
<LINK REL="next" HREF="node52.html">
</HEAD>
<BODY >
<DIV CLASS="navigation"><!--Navigation Panel-->
<A NAME="tex2html1386"
HREF="node52.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1380"
HREF="node49.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1374"
HREF="node50.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1382"
HREF="node14.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<A NAME="tex2html1384"
HREF="node317.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1387"
HREF="node52.html">Packages and Versions</A>
<B> Up:</B> <A NAME="tex2html1381"
HREF="node49.html">SIDL Files</A>
<B> Previous:</B> <A NAME="tex2html1375"
HREF="node50.html">Basic Structure</A>
<B> <A NAME="tex2html1383"
HREF="node14.html">Contents</A></B>
<B> <A NAME="tex2html1385"
HREF="node317.html">Index</A></B>
<BR>
<BR></DIV>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION02422000000000000000"></A><A NAME="1901"></A><A NAME="1902"></A>
<BR>
Comments and Doc-Comments
</H2>
<P>
SIDL has the same commenting style as C++/Java
and even has a special documentation comment
(so called <SPAN CLASS="textit">doc-comment</SPAN>) similar to those
used in Javadoc.
One can embed comments anywhere in their SIDL file.
Documentation comments should immediately precede
the class, interface, or method with which they are associated.
Babel replicates documentation comments in the files it generates.
It does not replicate plain comments.
<P>
<BR>
<PRE CLASS="verbatim">/*
* 1. This is a multi-line comment.
*
*/
// 2. This comment fits entirely on a single line.
/* 3. This comment can fill less than a line. */
/** 4. This is a documentation comment. */
/**
* 5. Documentation comments can span
* multiple lines without the beginning
* space-asterisk-space combinations
* getting in the way.
*/
</I></PRE></td></tr></table></blockquote>
<P>
Consider the above SIDL file fragment.
<OL>
<LI>This comment is a regular multi-line comment that is
delimited by a slash-star , star-slash
(``<TT>/*</TT>'', ``<TT>*/</TT>'') pair.
</LI>
<LI>This is a single-line comment that starts
with a double slash ``<TT>//</TT>'' and continues
to the end of the line.
</LI>
<LI>This comment is the same as # 1 except that it
is completely contained on a single line. It can
be embedded in the middle of a line anywhere
a space naturally occurs.
</LI>
<LI>This is a documentation comment. In keeping with
Javadoc, Doc++, and other tools, it is delimited by
slash-star-star and star-slash
(``<TT>/**</TT>'', ``<TT>*/</TT>'') combinations.
Documentation comments are important because their
contents are preserved by Babel in the corresponding
generated files. Doc-comments must directly
precede the interface, class, or method that they
document.
</LI>
<LI>This is a multi-line variant of a doc-comment. Note
that initial asterisks on a line are assumed to
be for human readers only and are discarded by
Babel when it reads in the text. The multi-line
doc-comment is the preferred way of documenting
SIDL.
</LI>
</OL>
<P>
<DIV CLASS="navigation"><HR>
<!--Navigation Panel-->
<A NAME="tex2html1386"
HREF="node52.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html1380"
HREF="node49.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html1374"
HREF="node50.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html1382"
HREF="node14.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<A NAME="tex2html1384"
HREF="node317.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html1387"
HREF="node52.html">Packages and Versions</A>
<B> Up:</B> <A NAME="tex2html1381"
HREF="node49.html">SIDL Files</A>
<B> Previous:</B> <A NAME="tex2html1375"
HREF="node50.html">Basic Structure</A>
<B> <A NAME="tex2html1383"
HREF="node14.html">Contents</A></B>
<B> <A NAME="tex2html1385"
HREF="node317.html">Index</A></B> </DIV>
<!--End of Navigation Panel-->
<ADDRESS>
<br><br>babel-0.10.2<br>users_guide Last Modified 2005-03-23<br><br><a href="http://www.llnl.gov/CASC/components">http://www.llnl.gov/CASC/components</a><br><a href="mailto:components@llnl.gov">components@llnl.gov</a>
</ADDRESS>
</BODY>
</HTML>
|
