Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

JavaDoc in supplied code

 
Mike Yu
Ranch Hand
Posts: 175
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
In the supplied source code ( I downloaded in Oct 2002), if there are some errors in JavaDoc comments, or it does not conform the JavaDoc convention or Java code convention, should I correct them or leave them as it is?
 
Vlad Rabkin
Ranch Hand
Posts: 555
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Mike,
I did correct them.
Regards,
Vlad
 
Mike Yu
Ranch Hand
Posts: 175
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thank you Vlad.
Anyone else has different opinion?
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12014
220
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Mike,
I also corrected them. My opinion is that we have been told that we have to provide Javadoc for all the classes we submit (and we are submitting the original classes).
Regards, Andrew
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic