nderground
Dec 15, 2021

Throughout my career I have encountered other software engineers who do not document their code. These engineers have often argued against documentation beyond the code itself. They argue that their code is "self-documenting".

I have suggested that they take a look at some wavelet signal processing code. Looking at this code it is easy to understand what it does. But this does not help with understanding why the code does what it code.

Unfortunately, these arguments have fallen on deaf ears.

A good code documentation tool is great. But unfortunately it will not help with those who believe that their code is "self-documenting".

Sign up to discover human stories that deepen your understanding of the world.

Free

Distraction-free reading. No ads.

Organize your knowledge with lists and highlights.

Tell your story. Find your audience.

Membership

Read member-only stories

Support writers you read most

Earn money for your writing

Listen to audio narrations

Read offline with the Medium app

nderground
nderground

Written by nderground

nderground was a social network designed for privacy. nderground.net never took off and has been shut down. See topstonesoftware.com and bearcave.com.

Responses (1)

Write a response