Ganish Patil wrote:I want to make professional documentation of my project. There are plenty of functions I used in my project to insert, update and fetch etc. records in database. I just want to make documentation so I could know which functionality of project( like Employee Registartion, Customer Sales from one date to another etc.) uses which method and which method returns what and fetches or does what and all, so I can avoid redundant methods which returns and does same job. Also will ease my workload If client request any changes or enhancements further. For this I need to have a list of methods with their features. Now I'm just writing method name, its usages, what it returns and where it is used in, all these information I'm writing in word file which is little uncomfortable. so any suggestion how to make documentation and if there is any good to suits my requirements or should I just continue with word file ?
Yes that I can generate from NetBeans IDE 8.0.2. which I'm using for my project.
Well for a start I would say use Javadoc.
yes so I can know that ex. employee registration form which calls getNewEmpId() to generate new empId and insertNewEmpInfo() to insert new employee information in database.
you also want some kind of visualisation of which methods call which other methods in the code?
Ganish Patil wrote:all these information I'm writing in word file which is little uncomfortable.
Ganish Patil wrote:Thank you so much Winston Gutkowski for such precious information. It helped me a lot
yes I got this. Actually this is my first project and I have no experience what sort of situation I may face in future ( That could be database structure or any functionality etc. ) so just want to keep good documentation of my project ( Documentation just for my understanding ) so I'll be able to understand the functionality and its flow and all even after few years( Generally we forget which logic and function we used in the previous projects whose codes we haven't gone through since long time ).
try to structure it so that nobody needs to read more than 10 "at once"
Ganish Patil wrote:so just want to keep good documentation of my project ( Documentation just for my understanding ) so I'll be able to understand the functionality and its flow and all even after few years( Generally we forget which logic and function we used in the previous projects whose codes we haven't gone through since long time ).
yes, I think I'm little unreasonably worried about the uncertain future changes and implementation.
Actually, we rarely forget logic
Ohh Point jotted down.
documentation is (or should be) about explaining what something does, not how it does it
hahaha yes absolutely correct. I read the article It was really helpful. I never knew, We also have to think about reducing the memory usage as much as we can, which is consumed by objects(as Heinz Kabutz gave an example of String concatenation, I really adore and eager to learn how to write such clean code ). Also admire the point which Kirk Pepperdine made about DRY. Once again much obliged for your advice.
You shouldn't need to explain the logic to your reader though - and if you do, it probably means that you need to re-write your code.