При программировании на компьютере иногда необходимо оставлять заметки или комментарии, чтобы другие разработчики могли легко просматривать ваш код. Независимо от того, является ли это проект с открытым исходным кодом или частный проект, комментарии необходимы для согласования с соразработчиками и возможными будущими разработчиками. Без комментариев код было бы просто невозможно поддерживать.
Шаги
Шаг 1. Понять цель комментирования компьютерной программы
- Читаемость здесь является ключевым моментом. Когда вы смотрите на комментарий, вы должны знать, что это комментарий, а не строка кода.
- Комментарий также должен быть полезен не только для вас, но и для всех, кто может прочитать исходный код вашей компьютерной программы.
Шаг 2. Придумайте короткий и простой способ изложить свою точку зрения
Комментарии не обязательно должны быть произведением искусства. Они должны быть краткими, аккуратными и прямолинейными.
Однако это не должно препятствовать использованию нескольких строк для комментария. Дело в том, что информация должна доходить до читателя
Шаг 3. Напишите комментарий, используя соответствующий синтаксис языка программирования
Шаг 4. Спросите себя, достаточно ли подробен ваш комментарий
Комментарий должен рассказывать кому-то, кто смотрит на исходный код, что на самом деле делает эта часть программы, без необходимости ее компилировать и запускать. Ваш комментарий достигает этого? Передает ли он все детали?
