/usr/share/doc/libantelope-java/manual/bk02ch08.html is in libantelope-java-doc 3.5.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 8. Comments</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="Antelope Users Guide"><link rel="up" href="bk02.html" title="Ant Coding Style Guidelines"><link rel="prev" href="bk02ch07.html" title="Chapter 7. Tasks"><link rel="next" href="bk02ch09.html" title="Chapter 9. Example Build File"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 8. Comments</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="bk02ch07.html">Prev</a> </td><th width="60%" align="center">Ant Coding Style Guidelines</th><td width="20%" align="right"> <a accesskey="n" href="bk02ch09.html">Next</a></td></tr></table><hr></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp61927584"></a>Chapter 8. Comments</h1></div></div></div><p>
More is better! In particular, write comments for the intended use of properties and targets. The build file itself will tell what is happening, the comments should explain why.
</p><p>
For target comments, use a block comment similar to this example:
</p><p>
</p><pre class="programlisting">
<!-- ==================== Dist Target ================================
The "dist" target creates a binary distribution of the application
in a directory structure ready to be archived in a tar.gz or zip file.
This target depends on two others:
* "compile" so that the entire web application (including external
dependencies) will have been assembled
* "javadoc" so that the application Javadocs will have been created
================================================================== -->
</pre><p>
</p><p>
Place target comments immediately above the target element, with a single blank line between the end of the comment and the start of the target.
</p><p>
For other comments, such as for properties or within a target, use the standard xml single line comment like this:
</p><p>
</p><pre class="programlisting">
<!-- this is a comment -->
</pre><p>
</p><p>
If a comment is longer than a single line, wrap it and indent the second and subsequent lines 4 spaces, for example:
</p><p>
</p><pre class="programlisting">
<!-- Put everything in ${build} into the MyProject-${DSTAMP}.jar file,
then copy it and the source jar to the ${dist} directory so
everything will be ready for moving to the ftp server. -->
</pre><p>
</p><p>
Do not put a blank line between a single line comment and the element it is describing, for example:
</p><p>
</p><pre class="programlisting">
<!-- this is where the api documents live -->
<property name="api_docs" value="${docs_home}/api"/>
</pre><p>
</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="bk02ch07.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="bk02.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="bk02ch09.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 7. Tasks </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 9. Example Build File</td></tr></table></div></body></html>
|