Javadoc comments

Hi

Is there a way of automatically creating the Javadoc comments to all the
methods of a class other than positioning to each method and typing /** ????

TIA
Shane

--
"If A is success in life, then A equals x plus y plus z. Work is x; y is
play; and z is keeping your mouth shut." -- Albert Einstein


8 comments

Shane Mingins wrote:

Hi

Is there a way of automatically creating the Javadoc comments to all the
methods of a class other than positioning to each method and typing /** ????

TIA
Shane


I wonder what good is documentation which is automatically generated.
Does it have any info about entities being documented?

--
Maxim Shafirov
IntelliJ Labs / JetBrains Inc.
http://www.intellij.com
"Develop with pleasure!"

0

Well... we just want to create the javadoc header for all methods and
classes definitions and complete it later (= as soon as possible). The
same as we do one by one, but not having to type "/**" for each
method/class. Got it?

Franklin.

Maxim Shafirov (JetBrains) wrote:

Shane Mingins wrote:

>> Hi
>>
>> Is there a way of automatically creating the Javadoc comments to all the
>> methods of a class other than positioning to each method and typing
>> /** ????
>>
>> TIA
>> Shane
>>


I wonder what good is documentation which is automatically generated.
Does it have any info about entities being documented?

0

I have to agree with Maxim on this one.

As much as I can relate to your desire to minimize effort; that
particular process is very easy to start and not complete. In general
it is much better to do it one by one. It is easier to spot the
missing Javadoc comment blocks and harder to end up with a bunch of
useless empty ones.

Tim


Franklin wrote:

Well... we just want to create the javadoc header for all methods and
classes definitions and complete it later (= as soon as possible). The
same as we do one by one, but not having to type "/**" for each
method/class. Got it?

Franklin.

Maxim Shafirov (JetBrains) wrote:

>> Shane Mingins wrote:
>>
>>> Hi
>>>
>>> Is there a way of automatically creating the Javadoc comments to all the
>>> methods of a class other than positioning to each method and typing
>>> /** ????
>>>
>>> TIA
>>> Shane
>>>
>>
>> I wonder what good is documentation which is automatically generated.
>> Does it have any info about entities being documented?
>>

0

OK. I agree. :$

When I "have no time" to comment while I code, I just create the header
and do inspection code afterwards. It points to the javadoc problems.

But I saw now that it also points to the methods without javadoc
comments. So, from now on, I won't create javadoc header and not
complete them. :)

Thanks,

Franklin.

Tim Haley wrote:

I have to agree with Maxim on this one.

As much as I can relate to your desire to minimize effort; that
particular process is very easy to start and not complete. In general
it is much better to do it one by one. It is easier to spot the
missing Javadoc comment blocks and harder to end up with a bunch of
useless empty ones.

Tim


Franklin wrote:

>> Well... we just want to create the javadoc header for all methods and
>> classes definitions and complete it later (= as soon as possible). The
>> same as we do one by one, but not having to type "/**" for each
>> method/class. Got it?
>>
>> Franklin.
>>
>> Maxim Shafirov (JetBrains) wrote:
>>
>>> Shane Mingins wrote:
>>>
>>>> Hi
>>>>
>>>> Is there a way of automatically creating the Javadoc comments to all
>>>> the
>>>> methods of a class other than positioning to each method and typing
>>>> /** ????
>>>>
>>>> TIA
>>>> Shane
>>>>
>>>
>>> I wonder what good is documentation which is automatically generated.
>>> Does it have any info about entities being documented?
>>>

0

>

I wonder what good is documentation which is automatically generated.
Does it have any info about entities being documented?


We are using DTO's .... they basically have a bunch of setters and getter
that I would just like to create some basic javadocs for them.

Am I missing something here by wanting to do this? Saving some typing was
one goal :)

Cheers
Shane


--
"I may have invented it, but Bill made it famous." --- CtrlAltDel
inventor David Bradley


0

Do you want to create some Javadocs like the following (taken from
Netbeans, generated with its Javadoc generator)?

/**

  • Getter for property helloWorld.

*/
public HelloWorld getHelloWorld() {
return helloWorld;
}

Then writing any Javadoc line would be a complete waste of time and
(screen) size.

Tom

0

Am I missing something here by wanting to do this? Saving some typing
was one goal :)


No, you aren't missing something, you are adding garbage to the source code.

Code are facts: what the program does.

Good docs explaining what's going on are intentions: what the computer should do (as intended by the developer/designer/...).

Docs that saying nothing new, for eample saying "method setX sets the value of X", and incomprehensible docs are garbage, reducing the legibility of the source code.

Outdaded docs are poison, leading the reader into error, and making him go after whoever didn't update them (you? :) with gun in hand just so that this doesn't happen again.

-- Posted by JetBrains Omea

0

Am I missing something here by wanting to do this? Saving some typing
was one goal :)


No, you aren't missing something, you are adding garbage to the source code.

Code are facts: what the program does.

Good docs explaining what's going on are intentions: what the computer should do (as intended by the developer/designer/...).

Docs that saying nothing new, for eample saying "method setX sets the value of X", and incomprehensible docs are garbage, reducing the legibility of the source code.

Outdaded docs are poison, leading the reader into error, and making him go after whoever didn't update them (you? :) with gun in hand just so that this doesn't happen again.

-- Posted by JetBrains Omea

0

Please sign in to leave a comment.