Programming

21556 readers

588 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Follow the programming.dev instance rules
Keep content related to programming in some way
If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities [email protected]

founded 2 years ago

MODERATORS

[email protected]

Literate Programming (www.literateprogramming.com)

submitted 1 week ago* (last edited 1 week ago) by [email protected] to c/[email protected]

11 comments fedilink hide all child comments

This is the name of a concept to combine source code and highly structured human-readable documentation, such that the main artefact is the documentation, and the secondary artefact the full source code extracted from it. Any change to the source means changing the explanatory documentation of the goals and reasoning at the same time. It was invented by no other than Don Knuth, and he, together with his collaborators, wrote the TeX program in it, to show how it is useful in practice.

I myself have used the technique in various occasions at work, for example when taking on an important but almost unreadable piece of code I inherited at work, to preparing sources for a complex algorithm for handover when I was leaving another larger project, and also in leisure coding.

The tool which is most widely used for this approach today is Emacs org-mode. It has the advantage that it works for every programming language, and you will likely find full examples for all languages you use, but many other tools (for example for vim) exist.

you are viewing a single comment's thread
view the rest of the comments

[–] [email protected] 0 points 1 week ago* (last edited 1 week ago)

If a function has 300 lines without a lot of supporting documentation then I doubt that it is “clear, readable and concise” anyway.

Code - not function. Files often have multiple functions in them. If you can't read and understand code - I don't want you on my team.

I have never found it hard at all to skip past comments that are not relevant because my code editor helpfully colors them differently from the rest of the code, making it easy. Does your editor not do the same?

If it's something people will simply skip over then it's not useful. Don't pollute code with tons of unnecessary comments that you think will be useful for some "perceived future". They just add to your maintenance work.

Write your code to be understandable and document the architecture/design separately.

It depends on what you are doing. If you are implementing relatively simple logic like a REST API handler, then it is probably overkill. If you are implementing a relatively advanced algorithm, then having a running narrative of what is going can be extremely helpful.

Agree - most code is pretty straight forward. Save the comments for where it's needed.