0 Replies - 13795 Views - Last Post: 18 February 2011 - 02:01 AM Rate Topic: -----

#1 n8schatten  Icon User is offline

  • D.I.C Regular
  • member icon

Reputation: 145
  • View blog
  • Posts: 263
  • Joined: 07-December 10

JavaDoc: The Unloved Child. A Pragmatic Approach | Javalobby

Posted 18 February 2011 - 02:01 AM

Since we had a discussion about commenting code and JavaDoc in the what NOT to do thread:
http://java.dzone.co...c-unloved-child

Quote

Project documentation is an important but awkward thing to do. Same is true for JavaDoc. The few special comments in the Java source code that are delimited by /** ... */. This short post presents a very pragmatic approach to JavaDoc and outlines the general best practices for successful sourcecode documentation.

This post has been edited by n8schatten: 18 February 2011 - 02:02 AM


Is This A Good Question/Topic? 1
  • +

Page 1 of 1