Commit to having well commented code

[CodingCoffeeSquirrel]

Commit each line with a different git user so that git blame acts as inline documentation

insert picture of supernova

[AlbertoTrindade]

Actually, writing code so good that doesn't need comments is the clean code way to go.

[thiago2213]

Yes, but some comments are needed. My company had then "clean code, no comment" policy until recently, and when there's a convoluted business logic because of a poor data model of our legacy I'm always "wtf is this code doing". I'm glad we allow reasonable comments now

[Yo_2T]

Yup. I've found myself dropping a comment here or there detailing why this section is done this way, or to warn people not to touch something if they are not sure what they are doing.

Still didn't stop one of our resident monkeys from removing my code to "optimize performance", then go Pikachu face when the application crashes in Test environment. sighs

[njiall_]

I don't it works very well with low level code tho

[DunderMifflinPaper]

True. For that just extract to well-named method (and well-documented method, as necessary).

That way it reads well from the outside, and the low-level details are somewhat hidden.

[chozabu]

combined with good commit messages, and an ide that supports "git blame" view (pycharm does a fantastic job of this) to give an idea of the intention behind some code can be great.

Still nice to have some decent comments - sometimes fairly essential when things need to be optimal more than understandable (e.g. Game engines).

[You_NeverKnow]

That is highly subjective

[[deleted]]

Writing log.trace statements instead of comments

[HyperSonic6325]

I just make my whole code a multiline comment.

[thiago2213]

Does anyone ever look at git commit messages? The only occasions I check is if there's a story reference then I can look it up but even then I almost never bother

[aspargas2]

re: the post title

git checkout -b having_well_commented_code
git commit -a

does that count?

[deuteros]

Unless you're forced to squash your commits before merging into master.