Results 1 to 5 of 5

Thread: documentation

  1. #1
    mcal is offline Member
    Join Date
    Jan 2008
    Posts
    39
    Rep Power
    0

    Default documentation

    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.

  2. #2
    CaptainMorgan's Avatar
    CaptainMorgan is offline Moderator
    Join Date
    Dec 2007
    Location
    NewEngland, US
    Posts
    835
    Rep Power
    9

    Default

    ...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.
    Vote for the new slogan to our beloved Java Forums! (closes on September 4, 2008)
    Want to voice your opinion on your IDE/Editor of choice? Vote now!
    Got a little Capt'n in you? (drink responsibly)

  3. #3
    tim's Avatar
    tim
    tim is offline Senior Member
    Join Date
    Dec 2007
    Posts
    435
    Rep Power
    8

    Default Programming method

    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 :D

    Good luck with your project mcal! ;)
    Last edited by tim; 02-03-2008 at 09:18 AM.
    Eyes dwelling into the past are blind to what lies in the future. Step carefully.

  4. #4
    mcal is offline Member
    Join Date
    Jan 2008
    Posts
    39
    Rep Power
    0

    Default

    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.

  5. #5
    Cnu
    Cnu is offline Member
    Join Date
    Feb 2008
    Posts
    13
    Rep Power
    0

Similar Threads

  1. Attaching the Java documentation
    By Eranga in forum NetBeans
    Replies: 11
    Last Post: 08-09-2010, 05:17 AM
  2. Java Documentation
    By ravian in forum New To Java
    Replies: 4
    Last Post: 12-04-2007, 10:45 AM
  3. Deadlock detection tools documentation
    By goldhouse in forum Threads and Synchronization
    Replies: 0
    Last Post: 07-18-2007, 06:18 AM
  4. QueueMetrics 1.4 (Documentation)
    By JavaBean in forum Java Software
    Replies: 0
    Last Post: 06-29-2007, 01:54 PM

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •