Какви са правилата за коментиране на код?

Благодарим ти, че като коментираш, помагаш на тези, които се учат да пишат код, да подобрят тяхната работа. Ето кои са някои от основните неща, които можеш да коментираш:

• Четимост: Колко описателни са имената на променливите? Странно ли е отстоянието или не съществува? Можеш да препоръчаш Насоки за четимост на кода, за да научат още по темата.
• Коментари: Дали някои по-сложни части от кода не могат да бъдат по-добре обяснени? Можеш да препоръчаш Пояснения чрез коментари, за да научат повече по темата.
• Структуриране на данните: Дали кодът няма да бъде по-добър, ако съдържа обекти вместо масиви? Съобразявай се с факта, че не всички познават всички структури от данни. Можеш да правиш предложения като това: "Тук би било подходящо използването на обекти. Ако още не си запознат с тях, можеш да се върнеш тук отново, след като научиш какво представляват в бъдеще."
• Изпълнение: дали се използва draw, когато всъщност може да се използва mouseClicked или keyPressed?

И, разбира се, когато коментираш, се въздържай от отрицание или обиди – давай качествена и полезна обратна връзка!