Во-первых, написание комментариев позволяет лучше сформулировать идеи, которые вы собираетесь реализовать.
Во-вторых, наличие толковых комментариев сильно упростит работу тем, кто будет поддерживать ваш код (а ведь это можете быть и вы, и вспомнить через год, что и зачем делалось, не так-то просто).
Комментарии должны быть полными, но не избыточными. Особо сложные моменты можно дополнительно пояснить примерами.
Если под рукой имеются средства автоматической генерации документации вроде javadoc, не поленитесь оформить комментарии в соответствии с ее требованиями.
1
1
?
1 программирование
1 IT
И ещё наличие комметариев упростит работу студентам, сдающих чужие лабы)
главное, студенту перед защитой лабы самому почитать комментарии… а то ведь некоторым и на это ума не хватает…
Помнится, делал лабу одному товарищу. Налепил комментариев в расчете на него: с юморком и матюками. А он, даже не заглянув в код, так все это препу и сдал. Хорошо, преп был сам молодой и понимающий, а то бы конфуз вышел :)
//золотые слова
1 этикет
Комментарии к коду стоит использовать не только для того, чтобы другие люди смогли понять… Бывает такое, что со временем можешь запутаться в своем же коде, особенно если проект большой очень…
Еще я бы посоветовал структурировать код сразу же, а не писать все с начала строки — позволяет избежать путаницы…
Только писать надо грамотные комментарии, а для этого зачастую достаточно описать словами для чего эта функция предназначена
1 напоминальник