Account Options

  1. Sign in
The old Google Groups will be going away soon, but your browser is incompatible with the new version.
Google Groups Home
« Groups Home
Java Posse
Home
+ new post
About this group
Join this group
Message from discussion JavaDoc and Comments
The group you are posting to is a Usenet group. Messages posted to this group will make your email address visible to anyone on the Internet.
Your reply message has not been sent.
Your post was successful
 
From:
To:
Cc:
Followup To:
Add Cc | Add Followup-to | Edit Subject
Subject:
Validation:
For verification purposes please type the characters you see in the picture below or the numbers you hear by clicking the accessibility icon. Listen and type the numbers you hear
 
Ricky Clarkson  
View profile  
 More options Aug 21 2012, 4:09 pm
From: Ricky Clarkson <ricky.clark...@gmail.com>
Date: Tue, 21 Aug 2012 17:09:05 -0300
Local: Tues, Aug 21 2012 4:09 pm
Subject: Re: [The Java Posse] Re: JavaDoc and Comments
Print | View thread | Show original | Report this message | Find messages by this author
I'd rather make a bold than a timid claim.

I have better tools for navigating code than I do Javadoc, and if I'm
reading code I see the Javadoc too; code is the superset of
information.  When I want to investigate an API I tend to just open
the code in IDEA.  I might not happen to read any of it, just use
Ctrl-F12 and Ctrl-Q to see the information I need, but if I do need to
drill down I'm already in the right place.

On Tue, Aug 21, 2012 at 3:44 PM, Jeb Beich <jebbe...@gmail.com> wrote:
>>>"And as a user of an api, would you rather read the code or the javadoc ?
>>> "

>>The code, in general.  It's more likely to be correct.  If the code looks
>> bad then the javadoc *might* clarify the intent but commit messages are more
>> likely to be accurate assuming you don't have a 'Latest changes' guy on the
>> team.

> That seems like a pretty bold claim to make in general. javadoc can be
> pretty useful for getting a bird's eye view of the big api, then zooming in
> to what you need. That's nice for a variety of reasons, such as comparing
> two similar libraries.

> --
> You received this message because you are subscribed to the Google Groups
> "Java Posse" group.
> To post to this group, send email to javaposse@googlegroups.com.
> To unsubscribe from this group, send email to
> javaposse+unsubscribe@googlegroups.com.
> For more options, visit this group at
> http://groups.google.com/group/javaposse?hl=en.


 
You must Sign in before you can post messages.
To post a message you must first join this group.
Please update your nickname on the subscription settings page before posting.
You do not have the permission required to post.
Create a group - Google Groups - Google Home - Terms of Service - Privacy Policy
©2013 Google