Форум » » Комментарии к коду - какими они должны быть? » Ответить

Комментарии к коду - какими они должны быть?

MasterSet: Сам я ни разу не программист, никогда этому специально не обучался и опыт имею довольно скромный. О комментариях я теоретически знаю, что хорошим тоном является их делать в тексте программы по нескольким причинам. Во-первых, возвращаясь к своей программе через год или два ты рискуешь не понять сам, что там наваял в свое время. Если же в твоем коде будет разбираться другой человек, то ему будет вдвойне сложно без комментариев. Это все понятно, но практика имеет свои сложности. Пытаясь писать комментарии к собственным программам я не могу толком понять, а что именно требует комментариев? Где они уместны, а где нет? Какова граница между разумной экономией сил при написании и достаточной информацией для тех кто будет разбирать код потом? Как вообще надо правильно писать комментарии к программе? У меня пока все сводится к общему обозначению того что делает каждая локация, ну и в лучшем случае еще объяснение того за какое действие отвечают некоторые куски кода. Может посоветуете хорошие статьи, примеры или просто дадите совет?

Ответов - 23, стр: 1 2 All

MasterSet: Шуткую я, барыня. Хотя сказать по правде, если сам для игры чего прикидываю графически, то как раз на листочке. А4 мне хватает вполне. Но графов не строю - нужды нет.

Ajenta: MasterSet А я вообще все проектные записи в тетрадке делаю, по-старинке :))

HIman: Программка для построения графов маленькая и простенькая, называется Explain вот небольшой обзорчик http://www.mindmap.ru/stat/feod.htm Мой граф к игре получается вот такой http://s003.radikal.ru/i201/1002/b7/cee46d54a614.jpg




полная версия страницы