documentation

[mcal]

Hi Guys,

I am writing the documentation for my java program. But i got stuck in the part where i have to write the program implementation. Can someone pls explain to me what type of information i have to write in the program implementation method? Thanks a lot.

[CaptainMorgan]

Quote:

...But i got stuck in the part where i have to write the program implementation. Can someone pls explain to me what type of information i have to write in the program implementation method?...

Writing the program implementation refers to writing the actual code to make the program perform its intended task, thus your questioning is a bit confusing.... If you're trying to write documentation for the method, how about writing what the method does? Sorry, but it seems kind of obvious to me... unless I misinterpreted your question which is very possible.

[tim]

Hello mcal and CaptainMorgan

Quote:

Originally Posted by mcal

i have to write in the program implementation method

In the context of this clause, I would think that it is expected of mcal to document the method (technique) of how he\she programmed the project. For example:

1. What level of polymorphism was used?
2. What data structures was used?
3. Does the program use threads?
4. How does it use streams for local or networked communication?

It's up to mcal how much information he\she can give. In my grade 12 project I created a 3D modeling program in Delphi. My documentation was 70 pages long and my teacher told me that they had no other choice, but to give me 100%. This was because my project could not be compared equally to those of the other students. Overkill

Good luck with your project mcal!

[mcal]

Yeah that's exactly what i have to write. But i'm still in the part of "Problem Definition", but in this section i have a part which says "Justification of program implementation method". I don't think that in this very part i have to write about what methods were used, because i think that comes in the section where i have to write about the "Design and Implementation". I think that in here i have to write something else. Thanks guys for your help, i'll try to figure it out.

[Cnu]

u can use javadoc !