Project In-Line Help: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
(Created page with "=Internal= * Projects !!!In-line Help The best mechanism so far is to maintain a HELP.txt file within the resources of the project, embed it into the...")
 
No edit summary
Line 3: Line 3:
* [[Projects#Patterns|Projects]]
* [[Projects#Patterns|Projects]]


!!!In-line Help
=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. For an example see [GCA], [cbmapper].
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:
 
<pre>
</pre>

Revision as of 00:39, 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: