Win a copy of Java 9 Revealed this week in the Features new in Java 9 forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic

documentation files, how many needed?  RSS feed

 
ruilin yang
Ranch Hand
Posts: 334
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I understand I need two:
1) javadoc document - html form
2) README.txt - plain text file as user doc.
Then should we make a separate file for design consideration ?
My assignment spec confuse me. It says " Design decisions should be briefly but clearly described in your comments."
Please give me some help advice.
Thanks
Ruilin
 
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!