posted 14 years ago
Hi, just wondering when writing Javadoc for param tags of say methods, can one use the <code> </code> syntax. Just wondering because:
(1) When describing params of methods, is one suppose to use natural english instead of refering to existing structures in code, for example, if referring to a deletedRecordsCache in the param tag, should one use natural English, for example, use deleted records cache, or enclose the structure withing <code>deletedRecordsCache</code>.
(2) I realise if using the <code></code> tags this could raise a problem, say using the same description for interface methods and the class that implements them, seeing the interface class may not have the appropriate data structures.
Thanks very much.