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.
Comments
Post a Comment