Project In-Line Help: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
The best mechanism so far is to maintain a HELP.txt file within the resources of the project, embed it into the root of the JAR artifact and dump it at stdout when needed. | The best mechanism so far is to maintain a HELP.txt file within the resources of the project, embed it into the root of the JAR artifact and dump it at stdout when needed. | ||
The code that reads the help file: | The code that reads the help file is the self-contained class InLineHelp that can be placed in the <tt>util</tt> package of the project: | ||
<pre> | <pre> | ||
</pre> | </pre> | ||
Revision as of 00:40, 1 June 2016
Internal
Overview
The best mechanism so far is to maintain a HELP.txt file within the resources of the project, embed it into the root of the JAR artifact and dump it at stdout when needed.
The code that reads the help file is the self-contained class InLineHelp that can be placed in the util package of the project: