---
title: "Comment by Mark on \"Why you should document your code.\" | Hashnode"
description: "Write comments: I definitely changed my mantra from Real Programmers do not comment their code to A quick description won&#39;t hurt. I think that&#39;s overcom"
url: "https://hashnode.com/posts/why-you-should-document-your-code/5d0f7959f4d779060b593e7f/comment/5d11ccde6a72440567a3f5ab"
---

[Discussion](https://hashnode.com/posts/why-you-should-document-your-code/5d0f7959f4d779060b593e7f)

Comment [Why you should document your code.](https://hashnode.com/posts/why-you-should-document-your-code/5d0f7959f4d779060b593e7f)

[Mark](https://hashnode.com/@mverleg)

[Jun 25, 2019](https://hashnode.com/posts/why-you-should-document-your-code/5d0f7959f4d779060b593e7f/comment/5d11ccde6a72440567a3f5ab)

> Write comments: I definitely changed my mantra from Real Programmers do not comment their code to A quick description won't hurt.

I think that's overcompensating a bit. Having redundant descriptions is useless, and having wrong/outdated descriptions is worse than useless, so technically it can hurt.

You mention someone asking you what the code does. That's a clue that it is not clear enough without comments.

But this is clear enough without the comment, in my opinion:

```
// @route: Gets all profiles
route.get("/profiles", (req, res, next) => {
    // ...
}
```

That said, I like the post and it has good lessons! Use good names, document apis, don't skip comments alltogether.

But just use your judgement on when comments are needed. Don't be extreme in either direction. Try simple code and good names _first_, and _then_ if it's still unclear, add comments.

(As a hint, anything that starts with "real programmers ..." can de [safely](https://en.wikipedia.org/wiki/No_true_Scotsman) disregarded as advice).

[j](https://hashnode.com/@chilimatic)

[Jun 25, 2019](https://hashnode.com/posts/why-you-should-document-your-code/5d0f7959f4d779060b593e7f/comment/5d11ccde6a72440567a3f5ab#reply-5d11cf372509fa0570a25496)

> (As a hint, anything that starts with "real programmers ..." can de safely disregarded as advice).

real programmers would never say such a thing ;D I am more curious what unreal programmers would do or perhaps surreal ones. :D
