Do not use comments that explain the code✕
CAUTION
Some files are private or not ready yet, if a link gives you a 404 that's
why :)
This is a work in progress, new notes will be added daily
List of note Indexes
-
🔒 PROJECTS -
🌐 ART -
🌐 TECHNOLOGY -
🔒 SCIENCE -
🔒 PHILO-PSYCHO -
🔒 HISTORY -
🔒 HEALTH -
🔒 GAMING -
🌐 KNOWLEDGE
.... |\| .|||. |\/| .|\\. .|.
.\\||/|. .\|..|| .\|..|||...||.....
.| .....||.|\\\\\\ ... |\\\/. .\\. .||
.\\| .|\\|..|\\ .\\\\ .\\|. .\\\\\| |\| |\\|
|\\ |\\|.. /\\\. |\|\\ \\\\|. .|\\. .\\\\|
.\\. |\\\\\\\|.. .\\| .\\||\\/|. |\\| .|/\|
\. .\\\||/\|.... \\| |\/ |\\\ |\\\| .\\| \\| ....
|\/ |\\| |\\\\\\\| |\|.\\\ \\\\. |\\\\| |\\ \\. ||..
..|||\| .. .\\\\. |\\\\\\ .\\|....|\\\. |\\\\\\ |/. |/
\\\|.. .\\\ |\\. .\\\| \\| |||\\\. ...|\\/||. .\\\
|\| |\/. /\\\\\| .\\\\. \\. .../|. .|\\\|. |\\\| |\\
. |||\\|. ..||| .\\|. |\| \\|..../\\| |\\| .\\\\\ ..
\\| .||\|.|.. |\\\|./\ \\||\. ||... .\\\\/. |\/||
..|/||. |\\\\\|. .|/\| ||. .||\\\ .|||. |\
.\/| \\\. .|\\\|||\\\||.. .|\\\\\\\|\\\\. /\\\\||. |
.|| |\\\\| .......|\\\\\\. .\\\. ..|||.... .\\\\|.. ...
\\||....|\\\\\\\\||\\\\\\\/ |\|....|||\\\\\\\/....|\\\|
||.|\||\\| .....|\\\\..\\| .|\\\. ||........ .|\|...
. |\ /\\/\\\\\\. |\. .\\\\\\. ./\\\\/ |\\\||.
.|\.|\| .|\|... .. ./\\|..|\\| ..
.|\\| .\\\\.\\\\\\\ \||...\\\|..|\\\|.||
|\. ..||....|| ... ..||\\\. .|.
... .......
Do not use comments that explain the code
Adding comments in your code that say what it's doing isn't really useful.
Your code should explain itself.
comments lie
There is no linter or error checks for comments, so when you update your code you might not update your comments and they become outdated.
But documentation is still pertinent! Make the difference between code comments and code documentation.
Comments still have a purpose, for example, explain why the code is weird, why was it made the way it is or linking to documentation, issues, etc...
examples:
instead of
// A status of 5 signals message sent
if (status == 5) {
console.log('message_sent')
}
do:
const MESSAGE_SENT = 5
if (status == MESSAGE_SENT) {
console.log('message_sent')
}