main - javadoc for String[] args -


i want make documentation program. function main receives parameters command-line: login, password etc(there 9 parameters).

/** * command-line interface.    * @param args login - login of user password - password, row splitter - symbol after each row in text file */ public static void main(string[] args){  } 

but person read html-documentation it's not convenient find decription every parameter. better way make javadoc each parameter(like @param login, @param password @param rowsplitter)? thanks.

you use commons cli, make life easier when documenting expected input , when extending functionality of program.

http://commons.apache.org/proper/commons-cli/


Comments

Popular posts from this blog

java - Jmockit String final length method mocking Issue -

asp.net - Razor Page Hosted on IIS 6 Fails Every Morning -

c++ - wxwidget compiling on windows command prompt -