• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

About the choice.txt file and your content.

 
Johnny Barbosa
Greenhorn
Posts: 26
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi folks!

I'm writing my choice.txt file.
However, I feel that I am writing a lot of thing, that is, I am describing a lot of details about classes, methods, interfaces, packages, and so on.

My question is: How much we need to describe in this file? I need to describe ALL classes that was developed such as: ClientTableModel, ClientMenuBar, ClientToolBar, ClientForm and so on??

I think that only the main classes such as the major Interfaces, relationship between Interfaces and pakages, and so on needed to be described.
What do you think?

For you have an idea, my file have more or less this topics:

1. General Considerations
1.1. About the system proposed: overview
1.2. Pattern M.V.C
1.3. Server side
...

2. Documentation
2.1. Interfaces, Classes, methods and variables Names
2.2. Java Doc
2.3. User guide
...

3. Layer View
3.1. View Interface
3.2. Action Interface
...

4. Layer Control
...
5. Layer Application
...

What do you think? Some suggestion to better??

Thanks very much.


 
Bear Bibeault
Author and ninkuma
Marshal
Pie
Posts: 65335
97
IntelliJ IDE Java jQuery Mac Mac OS X
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
"Asobrabr asobrab", please check your private messages for an important administrative matter.
 
Johnny Barbosa
Greenhorn
Posts: 26
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Bear Bibeault wrote:"Asobrabr asobrab", please check your private messages for an important administrative matter.

Ok. Updated!
 
Roel De Nijs
Sheriff
Posts: 10662
144
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Johnny,

Welcome to the ranch!

Here you can read what others did with their choices.txt file

Kind regards,
Roel
 
Jeffry Kristianto Yanuar
Ranch Hand
Posts: 759
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I grouped my choices based on package. My package is based on the layer such as GUI, networking, db, and others



Jeffry Kristianto Yanuar SCJP, SCJA, SCJD
 
Johnny Barbosa
Greenhorn
Posts: 26
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Passed SCJD 391/400 (97.75%)! More information.
 
Jeffry Kristianto Yanuar
Ranch Hand
Posts: 759
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Congrats !!!

Jeffry Kristianto Yanuar SCJP, SCJA, SCJD
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic