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