Кстати, да!

Короткие полезные советы,
основанные на личном жизненном опыте,
иногда печальном.

Войдите

или зарегистрируйтесь!

Это вам пригодится, когда вы решите поделиться с нами советом, проголосовать за совет или оставить комментарий. И заодно пропадёт этот надоедливый текст!

Например, здоровье
1

Программист, не забывай про комментарии к коду. +24+24/-0, 41 прочитавший

Во-первых, написание комментариев позволяет лучше сформулировать идеи, которые вы собираетесь реализовать.
Во-вторых, наличие толковых комментариев сильно упростит работу тем, кто будет поддерживать ваш код (а ведь это можете быть и вы, и вспомнить через год, что и зачем делалось, не так-то просто).

Комментарии должны быть полными, но не избыточными. Особо сложные моменты можно дополнительно пояснить примерами.
Если под рукой имеются средства автоматической генерации документации вроде javadoc, не поленитесь оформить комментарии в соответствии с ее требованиями.

Код для вставки в блог Ой, нет, я лучше руками
×

Получится вот так
...

Написал MaaKut очень давно, 4 декабря 2009 в 14:59

Комментарии (6)

  1.   1
    Поставил MaaKut 4 декабря 2009 в 15:00¤
  2.   1

    Тег IT

    Поставил kstatida.ru 4 декабря 2009 в 15:22¤
  3.   5

    И ещё наличие комметариев упростит работу студентам, сдающих чужие лабы)

    Написал muller 5 декабря 2009 в 01:51¤
  4.   0

    главное, студенту перед защитой лабы самому почитать комментарии… а то ведь некоторым и на это ума не хватает…

    Написал derrick 7 декабря 2009 в 17:13¤
  5.   0

    Помнится, делал лабу одному товарищу. Налепил комментариев в расчете на него: с юморком и матюками. А он, даже не заглянув в код, так все это препу и сдал. Хорошо, преп был сам молодой и понимающий, а то бы конфуз вышел :)

    Написал MaaKut 12 декабря 2009 в 18:54¤
  6.   0

    //золотые слова

    Написал drunky 8 декабря 2009 в 21:11¤
  7.   1

    Тег этикет

    Поставил HolyAnimal 6 декабря 2009 в 22:56¤
  8.   1

    Комментарии к коду стоит использовать не только для того, чтобы другие люди смогли понять… Бывает такое, что со временем можешь запутаться в своем же коде, особенно если проект большой очень…
    Еще я бы посоветовал структурировать код сразу же, а не писать все с начала строки — позволяет избежать путаницы…

    Написал Dastonix 7 декабря 2009 в 18:56¤
  9.   0

    Только писать надо грамотные комментарии, а для этого зачастую достаточно описать словами для чего эта функция предназначена

    Написал vlivyur 9 декабря 2009 в 00:39¤
  10.   0
    Поставил(а) Spambot 26 декабря 2009 в 01:02¤

Незарегистрированные пользователи не могут оставлять комментарии.
Хотите зарегистрироваться? ?