|
To generate Java documentation pages, you must use the javadoc program. It wants you to describe your code using a special-form comment: /** However, many people consider /* */ comments to be unsafe, because it's so easy to leave off or delete the */ and accidentally comment out a big chunk of your code.
It would be nice if javadoc accepted /// as well as /**. Perhaps someday it will. For now, though, this little filter is a reasonable workaround. All it does is copy input to output, changing any /// comments into /** comments. It handles multi-line comments correctly. It even deals with things like one form of comment inside the other, or comment characters in quoted strings.
