Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"

Re: documentation best practices for internal modules

by sundialsvc4 (Abbot)
on Jan 08, 2018 at 23:55 UTC ( #1206939=note: print w/replies, xml ) Need Help??

in reply to documentation best practices for internal modules

I have read plenty of unfamiliar code that was written by someone whose then-present motivations I simply did not understand, except for the comments that he left behind ... and that person was me.   If you set-aside a program that you wrote, even for a very short time, then you will frankly be amazed at how little you actually remember of what you did and why.   The programmer’s intentions will now be an utter mystery.   Comments and per-sub documentation is therefore quite essential.

I also believe that you should maintain your code in a change-control system and keep an issue-tracker ... even though you imagine that no one other than yourself will ever touch this code and that you will remember everything.   You will not.

“Code review” awareness is also crucial even if you are reviewing yourself.   Would someone who had never encountered this piece of code before, manage to understand it ... accurately and quickly?   Is the logic “stupid simple?”   Yes, this is important, because soon enough that person will come along.   And that person could very well be you.

  • Comment on Re: documentation best practices for internal modules

Log In?

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://1206939]
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others cooling their heels in the Monastery: (6)
As of 2020-11-26 10:40 GMT
Find Nodes?
    Voting Booth?

    No recent polls found