• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Jeanne Boyarsky
  • Ron McLeod
  • Paul Clapham
  • Liutauras Vilda
Sheriffs:
  • paul wheaton
  • Rob Spoor
  • Devaka Cooray
Saloon Keepers:
  • Stephan van Hulst
  • Tim Holloway
  • Carey Brown
  • Frits Walraven
  • Tim Moores
Bartenders:
  • Mikalai Zaikin

About comment

 
Ranch Hand
Posts: 240
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • 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 ]
 
author and jackaroo
Posts: 12200
280
Mac IntelliJ IDE Firefox Browser Oracle C++ Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • 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
    Number of slices to send:
    Optional 'thank-you' note:
  • 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
Posts: 12200
280
Mac IntelliJ IDE Firefox Browser Oracle C++ Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hi Damu,
Correct.
Regards, Andrew
 
Everybody's invited. Except this tiny ad:
a bit of art, as a gift, that will fit in a stocking
https://gardener-gift.com
reply
    Bookmark Topic Watch Topic
  • New Topic