| 1 |
Munge is a purposely-simple Java preprocessor. It only supports |
| 2 |
conditional inclusion of source based on defined strings of the |
| 3 |
form "if[tag]", "if_not[tag]", "else[tag], and "end[tag]". |
| 4 |
Unlike traditional preprocessors, comments, and formatting are all |
| 5 |
preserved for the included lines. This is on purpose, as the output |
| 6 |
of Munge will be distributed as human-readable source code. |
| 7 |
|
| 8 |
To avoid creating a separate Java dialect, the conditional tags are |
| 9 |
contained in Java comments. This allows one build to compile the |
| 10 |
source files without pre-processing, to facilitate faster incremental |
| 11 |
development. Other builds from the same source have their code contained |
| 12 |
within that comment. The format of the tags is a little verbose, so |
| 13 |
that the tags won't accidentally be used by other comment readers |
| 14 |
such as javadoc. Munge tags must be in C-style comments; |
| 15 |
C++-style comments may be used to comment code within a comment. |
| 16 |
|
| 17 |
Like any preprocessor, developers must be careful not to abuse its |
| 18 |
capabilities so that their code becomes unreadable. Please use it |
| 19 |
as little as possible. |