Skip to main content

Marco Castellani's Library tagged programming →  View Popular

13 Jul 09

How to Write Doc Comments for the Javadoc Tool

  • A doc comment is written in HTML and must precede a class, field,
    constructor or method declaration. It is made up of two parts --
    a description followed by block tags. In this example, the block
    tags are @param, @return, and
    @see.
  • An @param tag is "required" (by convention) for every parameter,
    even when the description is
    obvious. The @return tag is required for every method that returns something
    other than void, even if it is redundant with the method description.
    (Whenever possible, find something non-redundant (ideally, more specific) to use
    for the tag comment.)
  • 1 more annotations...
24 Jun 09

java.net: A Dozen Ways to Get the Testing Bug in the New Year

  • Writing tests first is a programming technique that takes practice, and lots of it. Accept the fact that you won't see miraculous results overnight. Experts say it takes a minimum of 21 days to build a positive habit and six months for it to become part of your personality. So when you feel yourself backsliding, don't despair. Just keep pressing on and pay careful attention to mental assertions you're making that could be codified in tests. Your brain will love you for it!
23 Jun 09

java.net: A Dozen Ways to Get the Testing Bug in the New Year

  • Notice that the result checking is now codified in the use of assertEquals() methods that automatically check whether the expected value (the first parameter) matches the actual value (the second parameter). There's no need for you to remember what the correct results should be.
  • Most Java IDEs have an integrated graphical runner just waiting to stroke your ego, such as this runner in Eclipse:
  • 5 more annotations...
22 Jun 09

Clarkware › JUnit Primer

  • unit tests are written to test the
    fundamental building blocks of the system from the inside out.
  • Any class that contains
    test methods should subclass the TestCase class.
  • 3 more annotations...
1 - 20 of 141 Next › Last »
Showing 20▼ items per page

Selected Tags

Related Tags

Sponsored Links

Ads by Google

Highlighter, Sticky notes, Tagging, Groups and Network: integrated suite dramatically boosting research productivity. Learn more »

Join Diigo