 |
 |
Hi, Good point. I believe the default in Eclipse these days is that if you type "/**" (no quotes) and then enter, it will make a comment block for you including stubs for @param and @return. --Jeremy -----Original Message----- From: Graf, Norman A. Sent: Friday, March 21, 2014 3:35 PM To: McCormick, Jeremy I.; hps-software Subject: RE: javadoc on methods Hello All, Both Netbeans and Eclipse allow you to add javadoc stubs to your classes with a few keystrokes or command line shortcuts. Norman ________________________________________ From: [log in to unmask] [[log in to unmask]] On Behalf Of McCormick, Jeremy I. [[log in to unmask]] Sent: Friday, March 21, 2014 3:31 PM To: hps-software Subject: javadoc on methods Hi, RE: Javadoc FYI, this is what I do for method doc on my Java classes: /** * This method does something neat. * @param aVar This variable is very special. * @return An arbitrary value. */ void someMethod(Object aVar); I think the @param and @return values plus a sentence or two on each method is probably sufficient. So it is quite simple really. You don't need to put HTML markup on the methods to display their names etc., as the Javadoc parser will do that automatically when the website is built. If you want to see the full HPS Javadocs, they are here: http://www.lcsim.org/sites/hps/apidocs/index.html The conditions system is fairly well documented (more to come as I'm currently adding missing doc to it) if you want examples of how it looks. http://www.lcsim.org/sites/hps/apidocs/org/hps/conditions/package-frame.html You can also add a packge-info.java file in the package root directory if you want to write extended (e.g. multi-paragraph) doc on an entire package. --Jeremy ######################################################################## Use REPLY-ALL to reply to list To unsubscribe from the HPS-SOFTWARE list, click the following link: https://listserv.slac.stanford.edu/cgi-bin/wa?SUBED1=HPS-SOFTWARE&A=1 ######################################################################## Use REPLY-ALL to reply to list To unsubscribe from the HPS-SOFTWARE list, click the following link: https://listserv.slac.stanford.edu/cgi-bin/wa?SUBED1=HPS-SOFTWARE&A=1