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

About comment

 
Bigwood Liu
Ranch Hand
Posts: 240
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
I have a question:
Shall I provide a comment at the beginning of all the files, before package code, which gives the classname,version information, data, copyright?
If I shall provide this kind of comment, whose copyright it belongs to?
In addition, need I write class variable comments?
Thank you first.
Regards,
Damu
[ September 05, 2003: Message edited by: damu liu ]
[ September 05, 2003: Message edited by: damu liu ]
 
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 Damu,
If you look at the JavaDoc home page you will find some links that will help you. In particular the How to write doc comments and Requirements for writing API specs. While on the home page, take a look at the doclets Sun provides - one of them might be very useful
I did provide @author and @version tags for all my classes.
I did not declare copyright on any classes - saves the whole issue of who owns copyright.
Regards, Andrew
 
Bigwood Liu
Ranch Hand
Posts: 240
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thank you Andrew!
I did write class/interface comment in every class, which includes @author,@version in it. But I think this comment is after the package code.
After I read the materials, I suppose I will provide package documentation, class/interface documentation, fields documentation, methods documentation. Am I right?
Regards,
Damu
[ September 06, 2003: Message edited by: damu liu ]
 
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 Damu,
Correct.
Regards, Andrew
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic