Java-Gaming.org    
Featured games (81)
games approved by the League of Dukes
Games in Showcase (481)
Games in Android Showcase (110)
games submitted by our members
Games in WIP (548)
games currently in development
News: Read the Java Gaming Resources, or peek at the official Java tutorials
 
    Home     Help   Search   Login   Register   
Pages: [1]
  ignore  |  Print  
  DocCheck - automatically find out which methods you forgot to document  (Read 2636 times)
0 Members and 1 Guest are viewing this topic.
Offline blahblahblahh

JGO Coder


Medals: 1


http://t-machine.org


« Posted 2006-08-07 13:11:12 »

From the realm of "brilliant tools that Sun forget to tell you they wrote" Smiley

http://java.sun.com/j2se/javadoc/doccheck/

(posted here because I *only just came across it*, and its small but brilliant).

Summaries include listing all your packages and giving a "percentage of missing comments" for each.

Also provides copy/pastable "guessed" comments for you to paste in to your source and edit wherever it can.

malloc will be first against the wall when the revolution comes...
Offline bohdan

Junior Member




Java-positive...


« Reply #1 - Posted 2006-08-07 13:34:33 »

Thats cool!  Grin,  Thanks for info!
Sad though, it is not in development since mid 2003, strange...

Bohdan.
Offline blahblahblahh

JGO Coder


Medals: 1


http://t-machine.org


« Reply #2 - Posted 2006-08-07 14:04:26 »

Mainly, it seems, because "it works".

However, I tried emailing the official support adress at Sun, and it bounced. Time to take those people who run the sun.com infrastructure out back and shoot them again Sad.

malloc will be first against the wall when the revolution comes...
Games published by our own members! Check 'em out!
Legends of Yore - The Casual Retro Roguelike
Offline bohdan

Junior Member




Java-positive...


« Reply #3 - Posted 2006-08-07 17:08:47 »

Actually, that DocCheck is really brilliant idea.. but I think it could be done better in regards to output. I just thought it would be very nice if it can be extended so, that output is not just a "dead" html files, but so that if I click on certain method missing the doc it will open up corresponding class itself in NotePad for instance... or better if it is possible to extend to be the Eclipse plugin, so that it will actually bring me to that particular method to do doc...

This will be huge help in documenting big projects! The way it is now - you actually need to go and search yourself, then when you done, you look up in html file another missing doc and go searching in you code again.... still good help but could be yet better! Smiley

What's you opinion?
Offline ryanm

Senior Member


Projects: 1
Exp: 15 years


Used to be bleb


« Reply #4 - Posted 2006-08-07 17:57:14 »

You can already set Eclipse to nag you for missing/wrong javadoc, ie: it'll appear as a warning or, if you're a particularly huge hard-ass, as an error.
Offline CaptainJester

JGO Knight


Medals: 12
Projects: 2
Exp: 14 years


Make it work; make it better.


« Reply #5 - Posted 2006-08-08 13:01:43 »

There's also a great, free tool called Jalopy http://jalopy.sourceforge.net/.  Although it is more than just a commenter.  It is also a code formatter.  But it does a good job with Javadoc comments.  It will format any existing ones and will add any new ones required.  Of course this is configurable to only add method level javadoc or field level.  It provides a default template that you can modify, so you can have TODOs in all the ones that you missed.  Plus it plugs into Eclipse seamlessly.

Offline Kova

Senior Member





« Reply #6 - Posted 2006-08-09 02:05:25 »

I've already mentioned this before, but what I'm looking for is some sort of commend hide / unhide plugin for eclipse or program. Basicly when I'm coding I don't want to look and browse through all of those comments, that would be great time to hide them. If I ever get stuck asking myself what does this code do, then I would unhide comments and see whats there... comments would remain in their lines, the thing I had in mind would just hide those lines from our view.
Anybody has something similar? Best I could do is make eclipse fold multi-line comments into one line.
Offline blahblahblahh

JGO Coder


Medals: 1


http://t-machine.org


« Reply #7 - Posted 2006-08-09 13:00:13 »

I just bought a bigger monitor Grin and told eclipse to do line-breaks at 160 columns instead of 80

malloc will be first against the wall when the revolution comes...
Pages: [1]
  ignore  |  Print  
 
 
You cannot reply to this message, because it is very, very old.

 

Add your game by posting it in the WIP section,
or publish it in Showcase.

The first screenshot will be displayed as a thumbnail.

atombrot (26 views)
2014-08-19 09:29:53

Tekkerue (24 views)
2014-08-16 06:45:27

Tekkerue (23 views)
2014-08-16 06:22:17

Tekkerue (14 views)
2014-08-16 06:20:21

Tekkerue (22 views)
2014-08-16 06:12:11

Rayexar (60 views)
2014-08-11 02:49:23

BurntPizza (38 views)
2014-08-09 21:09:32

BurntPizza (30 views)
2014-08-08 02:01:56

Norakomi (37 views)
2014-08-06 19:49:38

BurntPizza (67 views)
2014-08-03 02:57:17
List of Learning Resources
by Longor1996
2014-08-16 10:40:00

List of Learning Resources
by SilverTiger
2014-08-05 19:33:27

Resources for WIP games
by CogWheelz
2014-08-01 16:20:17

Resources for WIP games
by CogWheelz
2014-08-01 16:19:50

List of Learning Resources
by SilverTiger
2014-07-31 16:29:50

List of Learning Resources
by SilverTiger
2014-07-31 16:26:06

List of Learning Resources
by SilverTiger
2014-07-31 11:54:12

HotSpot Options
by dleskov
2014-07-08 01:59:08
java-gaming.org is not responsible for the content posted by its members, including references to external websites, and other references that may or may not have a relation with our primarily gaming and game production oriented community. inquiries and complaints can be sent via email to the info‑account of the company managing the website of java‑gaming.org
Powered by MySQL Powered by PHP Powered by SMF 1.1.18 | SMF © 2013, Simple Machines | Managed by Enhanced Four Valid XHTML 1.0! Valid CSS!