• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Number of classes/interfaces

 
Tony Morris
Ranch Hand
Posts: 1608
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Just rereading the requirements before I consider submission.
"A clear design, such as will be readily understood by junior programmers, will be preferred to a complex one, even if the complex one is a little more efficient. Code complexity, including nesting depth, argument passing, and the number of classes and interfaces, should be reasonable. "
Number of classes is (of course) relative.
How does 72 source files plus 8 JUnit test case source files sound ?
I'm submitting the JUnit test cases because I consider it to be "related parts of my project".
Submission requirement:
"A directory called code, containing all the source code and related parts of your project"
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12007
215
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Tony,
Wow. I had 54, and I considered my design to be more complex than necessary.
Max's DVD project seems to have 24 which includes both sockets and rmi interfaces.
Most of my classes and interfaces were in my GUI, and I didn't loose any marks in that section. So I wouldn't be too concerned about the number of classes and interfaces. What is more important is whether the junior programmer/examiner can easily determine what class does what and navigate through it all. To help with that, I included class diagrams in my submission.
Regards, Andrew
 
Tony Morris
Ranch Hand
Posts: 1608
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I considered submitting a UML diagram, but feared the possibility of exceeding the requirements.
How on earth did you do that ?
In choices.txt with some fancy ASCII ?
In the javadoc ?
 
Vlad Rabkin
Ranch Hand
Posts: 555
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Tony,
Andrew said to me, you can submit html mit jpg files if you want to provide diagramms.
Best,
Vlad
 
Tony Morris
Ranch Hand
Posts: 1608
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Vlad,
Thanks for the comment.
I assume you mean you have diagrams in the User Guide.
Why put design diagrams in the User Guide ?
The user should be abstracted from the design of the software, only to be told how to operate it.
Is there something I'm missing ?
 
Vlad Rabkin
Ranch Hand
Posts: 555
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Tony,
I assume you mean you have diagrams in the User Guide.

Good question! I don't know
I would put it in choises, but choises.txt MUST be a plain text file (not html).

There are two opportunities:
javadoc - I don't think it is good idea, since javadoc doesn't conmtain normally class diagramms.
User Guide has nothing actually to do with technical design.
I will have to think about...

Best,
Vlad
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12007
215
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Tony / Vlad,
Actually mine were links from the design choices document, which was HTML (we were allowed to do it in HTML for the FBNS assignment).
You could do them as ASCII text diagrams I suppose.
Or just do them in HTML and state in your readme / choices document that they exist in 'xxx' location.
Regards, Andrew
 
Tony Morris
Ranch Hand
Posts: 1608
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I now have 71 source files (after creating my own SwingWorker.java implementation) plus 8 JUnit test case source files, which, in totality, compiles to 123 classes (a lot of anonymous classes in the client).
I have decided that I will not include a UML diagram simply because I think it would be subject to error and is probably not intended to be done as choices.txt is strictly stipulated to be ASCII (maybe they got sick of seeing poor design diagrams ?)
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12007
215
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Tony,
maybe they got sick of seeing poor design diagrams ?

Probably they got sick of recieving Microsoft Word documents - the old Fly By Night Services assignment did not specify what format the document should be in, so it was up to the developer. I guess Sun learnt not to allow that
Regards, Andrew
 
Vlad Rabkin
Ranch Hand
Posts: 555
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Andrew and Tony,
Andrew:
Probably they got sick of recieving Microsoft Word documents


Vlad
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic