Which sort of documentation do youfind most beneficial as a developer ?(please w
ID: 3617532 • Letter: W
Question
Which sort of documentation do youfind most beneficial as a developer ?(please wiki or google theones with which you are unfamilar with)
o Functional In linecomments
o Contract In linecomments
o Header comments (briefoverview at the top of a file)
o Specficationdocument
o Use case
o Unit test
o Help document (how touse the final product. No implementation details)
o Self documentedcode
o Annotated code
I may have missed some, pleasefeel free to not choose from the list. Please also note that nocomments is not an acceptable answer.
Explanation / Answer
Functional In line comments can beneficial for a developer asthey provide description to most of the code. A simple, commentedprogram will have a comment for every other line of code that needsexplanation. It will be good for the developers
(1) Functional In line comments - Comments appearing directlybefore a function or type definition. They are used to document afunction or type.
(2)Contract In line comments – Comments are included onthe contract basis as per line rate. Due to economy or cost thecomments may be less.
(3) Header comments - A header comment can be a file header orclass header or a method header. The header comment gives adescription of the feature (file or method or class)
(4)Specfication document - The specification documentationtypically describes what is needed by the system user as well asrequested properties of inputs and outputs. It describes theessential technical requirements for items, materials, or servicesincluding the procedures by which it can be determined that therequirements have been met
(5)Use case - use case document is a formal document based on adetailed template with fields for various sections.
(6)Unit test - Test case document gives the test plan and testresults for unit testing of some of the key modules.
The use case and unit test documents cannot help much for adeveloper as they contain descriptions about various test cases andsections.
(7)Help document - Help documentation provides information aboutvarious tools and technologies that accompanies the software. It isalso not much suitable for a developer because it gives the basicidea about the tools and technologies etc.
(8)Self documented code – A self documented code givesself explanation through the names of the methods, variables,classes etc. A self documented code can be helpful for developersto understand the code. But it depends on the situation where it isneeded.
(9)Annotated code - Annotations provide data about a programthat is not part of the program itself. Like the referencesfrom which it is taken and all.
Related Questions
drjack9650@gmail.com
Navigate
Integrity-first tutoring: explanations and feedback only — we do not complete graded work. Learn more.