GeeCON Prague 2014*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Documentation for SCJD and best practices! Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "Documentation for SCJD and best practices!" Watch "Documentation for SCJD and best practices!" New topic
Author

Documentation for SCJD and best practices!

Ixus See
Ranch Hand

Joined: Jul 17, 2011
Posts: 160
Hello Guys,

I completed my assignment !!! Yes finally!

now I need your help with documentations...

1) Is there a guidelines to javadoc ? I remember there are some standard English structure and naming convention.

2) User guides - Any good software to produce decent user guides? are we allow to attach pictures and is there are standard way of structuring it.

3) any tools/eclipse plugin to recommend for Static code analyst, javadoc and check style

4) exam questions.. I'm planning to register for the exam next week.. any sample exam questions? i am kind of worried.

5) logging guidelines and what should be logged.

6) a full check list of what is MUST and etc...

some other concern about coding

1) I didn't set full screen for UI.. will i be penalize for that?

2) my data class is not facade pattern.. is it a good idea to refactor to it? what is a good justification for not using facade pattern...

I can't really think of a good reason except being lazy for this. HA HA
Chris Zaremba
Ranch Hand

Joined: Nov 22, 2010
Posts: 54

I stuck to the specs and examples shown at oracle Javadocs at Oracle

I stuck to a simple text editor (textpad) and didn't include any screenshots. From memory you can either use, plain ascii text file, html or online (part of app rather than on internet). Text files are by far the simplest.

There is some javadoc checking in eclipse such as making sure nothing is missing. I generated the docs and got a friend to proof read it for mistakes etc.

As for the exam, just make sure you know your project well. You will need to explain why you did certain things the way you did and maybe discribe part or its usage.

I used log4j while writing the app and then removed all logging at the end. All checked exceptions were translated into meaningful error messages. Logging is not a must requirement.

I didn't set full screen but it could be maximized without any problems.

I used a facade so that i could split the locking and data access up but if you think you way is justified then i can't see a problem.

MAKE SURE YOU WRITE ABOUT ALL YOUR DESIGN CHOICES!

The must requirements will be dependant on you individual assignment. How about doing a text search for the word must and highlight all entries.

By the way i would suggest waiting until you have finished or nearly finished all the documentation before booking the exam. All the documentation, packaging etc took me almost as long as writing the actual code. You don't want to leave yourself short of time.


SCJA, OCPJP, OCMJD
Roel De Nijs
Bartender

Joined: Jul 19, 2004
Posts: 5299
    
  13

documentations:

1/ just stick to the conventions described by Sun (Oracle)

2/ you are allowed to do what you want. I don't see why you would need some software to produce a user guide for such a simple application

3/ if you use the search engine of this forum you'll definitely find a few topics discussing them (I experimented with a few)

4/ you'll get 4 open questions (no multiple choice) about your assignment. If you developed the assignment yourself and you know what you were doing, you'll have no reason for being worried. making exam questions public is not allowed, so no sample questions.

5/ read your instructions again and you'll find the answer

6/ read your instructions again and everything containing the word "must" is a must


code:
1/ no

2/ my data class is also not a facade. But you are contradicting yourself: in another thread you say "I love design patterns and i always preach it but sadly i don't have much chance to apply them. ". So you have the opportunity to apply one and you don't do it.


SCJA, SCJP (1.4 | 5.0 | 6.0), SCJD
http://www.javaroe.be/
Roel De Nijs
Bartender

Joined: Jul 19, 2004
Posts: 5299
    
  13

Chris Zaremba wrote:By the way i would suggest waiting until you have finished or nearly finished all the documentation before booking the exam.

Since Oracle's new test delivery partner you can't schedule the essay exam anymore if you didn't submit your assignment.
Ixus See
Ranch Hand

Joined: Jul 17, 2011
Posts: 160
1) I didn't set full screen for UI.. will i be penalize for that? >> The instruction didn't say anything at all.. =X

and yes I know I am contradicting myself on that, but the data class has change so much since the being until I am too lazy and worried about breaking anything if i refactor it (when i was posting that message)

Anyway I just refactor it to facade pattern -.-

Roel De Nijs
Bartender

Joined: Jul 19, 2004
Posts: 5299
    
  13

Ixus See wrote:and worried about breaking anything if i refactor it (when i was posting that message)

That's why you have (or should have) test cases. They prevent that when you refactor, you break your code (program).
Ixus See
Ranch Hand

Joined: Jul 17, 2011
Posts: 160
just curious is there an eclipse plugin that help you check your java doc..

I am using check style but is have too much error and make it not very constructive.. example line is longer than 80 charactors -.-

and I need to package-info java file?

heehee, I am copying from help files.. especially for the exceptions :P
Roel De Nijs
Bartender

Joined: Jul 19, 2004
Posts: 5299
    
  13

Ixus See wrote:is there an eclipse plugin that help you check your java doc.

You can generate javadoc from Eclipse (menu-item) and then you get output about all generated files and a number of warnings/errors. I solved all these errors/warnings and that's it. Besides the compiler errors/warnings in Eclipse (you can change in preferences) I also did not use a code checker (because I do not need that )

Ixus See wrote:and I need to package-info java file?

I added a package.html in each package, both files are similar (although the package-info file has more possibilities)
Sean Keane
Ranch Hand

Joined: Nov 03, 2010
Posts: 581

Ixus See wrote:I am using check style but is have too much error and make it not very constructive.. example line is longer than 80 charactors


You can configure Checkstyle with rules.


SCJP (1.4 | 5.0), OCJP (6.0), OCMJD
 
GeeCON Prague 2014
 
subject: Documentation for SCJD and best practices!