Прихильники

11/06/2017

Чому не варто писати коментарі в коді?

Share & Comment
Всім програмістам говорили про необхідність коментарів в коді, але чи потрібні вони? Ми постараємося розібратися в цій темі і розповімо чому коментарі це зло!
Про професіоналізм програміста можна судити на підставі декількох факторів, що присутні в коді: правильні імена змінних і конструкцій, логічне виконання поділок на розділи, прості способи вирішення складних завдань, наявність зручної структури і коментарі до основних функцій. На рахунок останнього фактора є деякі сумніви, тому що коментарі не завжди свідчать про професійні навички. Для новачків це може стати проблемою, що заважає розвиватися. Тепер ближче до суті.
Кому і навіщо потрібні коментаріВсього коментування коду виконує 4 основні завдання:

  
  Проста навігація. Вельми часто доводиться знаходити   усувати       помилки в коді, за допомогою навігації простіше знайти блок, що займається обробкою потрібного напрямку. Особливо складно, якщо програма іншого розробника;
  
  Пояснення коду. Коли використовуються специфічні функції зі складними математичними, хімічними або іншими формулами. Навіть хороший фахівець може не знати специфіку будь-якого напрямку;
  
  Опис всього коду в цілому. Використовується при формуванні    великих   обсягів даних, наприклад, бібліотек, розширень і практично у всіх сферах програмування з загальнодоступним кодом;
  
  Опис очікуваного результату функції. В цьому випадку коментарі використовуються для налагодження коду та перевірки результату.


Чим погано

Ще в далекому 2008 році вперше зазвучали ідеї щодо коду без коментарів. Першим сформулював ідею Роберт Мартін у своїй книзі «Чистий код». У виданні було наведено безліч варіантів оптимізації написаного року, серед них вказувалася ідея повної відмови від системи коментування. Думка Мартіна зводилося до того, що код часто обмежує розробника в вираженні власних ідей. Через використання коментарів багато програмісти не займаються оптимізацією і структуруванням коду.

Для прикладу наведемо ситуацію: поруч з усіма функціями, що виконують послідовні дії, встановлюються коментарі тільки через банальну нудьгу розробника або неправильного написання


Що робити

Повністю виражатися проти коментарів ми не будемо, так як це є важливою частиною коду, але їх кількість повинна бути невеликою і обґрунтованим. Коментарі покликані тільки зробити код більш читабельним.
Приступимо до занять, першим буде повна відмова від підписів, які розташовуються правіше від коду. Не потрібно просто видаляти коментарі, так ви нічому не навчитеся. Видаляючи підписи постарайтеся зробити так, щоб читаність і інформативність від цього не постраждала. Використання багаторядкових коментарів допустимо, вони виконують лише роль навігації. Методика покликана:

  
Виконати оцінку якості і чіткості написаного коду;
  
Допомогти виявити безліч коментарів, що абсолютно марні;
  
Знайти способи досягнення оптимізації написаного коду, при                

       цьому      
     спростивши його для розуміння;
  
Навчити правильно оформляти роботи, доречно розставляючи прогалини, відступи і табуляції.
Якщо можливість пояснення відпадає як мінімум з'являється необхідність давати смислові назви змінним і об'єктів, що вже стане кроком у розвитку програміста.
 
 


І все ж без коментарів нікуди

Налагоджений, структурований код з коментарями - це гранично зручна робота з програмою протягом усього періоду налагодження. Коментарі допоможуть зробити код легко читаним, поліпшать навігацію по документу, зроблять код доступним для іншого розробника. Злом їх можна назвати лише в разі пояснення написаного коду, коли програміст нехтує правильною структурою на користь роз'яснення дій. Це ніщо інше як милиці, які лише прикривають недобросовісно написаний код. Викиньте милиці і зможете підкорити Еверест в програмуванні значно швидше. 
 
Copyright © ProIT News | Designed by ITeam