Улучшенное комментирование кода программы

Другие статьи из рубрики «Работа репетитора»

Содержание:

Я – профессиональный исполнитель всевозможных проектов по программированию на заказ

Приветствую всех на моем сайте! Меня зовут Александр Георгиевич. Я – московский профессиональный репетитор по информатике, программированию, математике, алгоритмам и базам данных.

Уже на протяжении 12 лет я готовлю школьников к успешной сдаче ОГЭ и ЕГЭ по информатике, а студентам преподаю современные и актуальные языки программирования, такие как Pascal, C, C++, C#.

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

Я прекрасно понимаю, что вы достаточно занятой человек, который ценит собственное время, но, несмотря на это, я настоятельно рекомендую вам потратить буквально 2-3 минуты и ознакомиться с отзывами учеников, прошедших под моим началом курсы индивидуальной подготовки. Все они достигли поставленных результатов, а некоторые из них даже - ошеломительных!

Свои частные занятия я провожу в различных территориальных форматах. Но, хочу обратить ваше внимание на тот факт, что большинство моих учеников предпочитает дистанционный формат уроков, посредством компьютерной программы "Скайп".

На дому
у ученика

На дому
у преподавателя

На нейтральной
территории

Дистанционно
по Skype

В данной публикации я бы хотел лаконично и доступно пояснить своим потенциальным клиентам то, каким образом происходит улучшенное комментирование кода программы. Вы получите полноценное представление о том, насколько простановка комментариев влияет на понимание программного кода.

Пример программы, использующей улучшенное комментирование

Предлагаю вам рассмотреть классическую задачу, обрабатывающую одномерный массив целых чисел. Кстати, чуть не забыл, обязательно посетите страничку, на которой я кратко поясняю, что такое поверхностные комментарии и сверхдетальные комментарии. У вас будет замечательная возможность сопоставить данные виды комментариев и принять однозначное решение в пользу одного из них.

Дан динамический одномерный целочисленный массив, состоящий из N элементов. Количество элементов запрашивается с клавиатуры от пользователя. Заполнение элементов массива осуществляется случайным образом из отрезка [-20 .. 50].

Вывести исходный массив на экран.
Найти сумму элементов массива.
Найти количество отрицательных элементов массива.
Отсортировать исходный массив методом «пузырька» и вывести его после сортировки на экран.

В качестве языка программирования буду использовать язык С++. Ваша задача очень внимательно ознакомиться с формулировкой условия, а затем внимательно, практически под микроскопом, изучить приведенный программный код. Особое внимание обращать на «зеленые строчки», являющимися комментариями.

Наличие комментариев в подобном объеме в коде программы я называю улучшенным комментированием.

// для запуска из Visual Studio
#include "stdafx.h"     
// для ввода-вывода информации
#include <iostream>     
// для настроек локализации
#include <locale>       
// для использования манипуляторов ввода-вывода
#include <iomanip>      
// для прямого обращения к операторам, находящимся в std
using namespace std;
//---------------------------------------------
// Заполнение элементов массива случайными значениями из отрезка [-20 .. 50]
//---------------------------------------------
// передается указатель на массив, а также количество элементов массива
void initVector(int *pv, const int pn)
{
// пробегаем по всем элементам массива
    for(int i = 0; i < pn; i++)
// генерируем случайное число из отрезка [-20 .. 50]
        pv[i] = rand() % 71 - 20;
}
//---------------------------------------------
// Вывод элементов массива на экран пользователя
//---------------------------------------------
// передается указатель на массив, кол-во элементов массив и диалог для печати
void printVector(int const *pv, const int pn, const char *pmessage)
{
// перед печатью элементов массива выводим информационное сообщение
    cout << pmessage;
// просматриваем все элементы заданного массива
    for(int i = 0; i < pn; i++)
// выводим на экран текущий элемент шириной в 5 позиций
        cout << setw(5) << pv[i];
// для повышения читабельности отступаем пару строчек в консольном окне
    cout << endl << endl;
}
//---------------------------------------------
// Нахождение суммы элементов массива
//---------------------------------------------
// передается указатель на массив и количество элементов массива
int getSumElemVector(int const *pv, const int pn)
{
// данная переменная отвечает за сумму и ее стартовое значение равно 0
    int sum = 0;
// просматриваем все элементы одномерного массива
    for(int i = 0; i < pn; i++)
// увеличиваем сумму на значение текущего элемента
        sum += pv[i];
// в качестве ответа функция возвращает посчитанную сумму
    return sum;
}
//---------------------------------------------
// Нахождение количества отрицательных элементов массива
//---------------------------------------------
// передаем указатель на массив и количество элементов массива
unsigned short getCountNegativeElem(int const *pv, const int pn)
{
// хранит количество отрицательных элементов
    unsigned short k = 0;
// пробегаем по всем элементам массива
    for(int i = 0; i < pn; i++)
// если значение текущего элемента меньше 0, то
        if(pv[i] < 0)
// найден очередной минусовой элемент -> добавляем его к общему
// количеству отрицательных элементов
            k++;
// в качестве ответа функция возвращает кол-во отрицательных элементов
    return k;
}
//---------------------------------------------
// Сортировка массива методом "пузырька"
//---------------------------------------------
// передается указатель на массив и его количество элементов
int* bubbleSortVector(int *pv, const int pn)
{
// переменная, которая служит для обмена двух значений
    int swap;
// запускаем цикл, который показывает, сколько раз нужно будет
// искать минимальный элемент
    for(int i = 0; i < pn; i++)
// в этом цикле ищется минимальный элемент и сдвигается в начало массива
        for(int j = pn - 1; j > i; j--)
// если текущий элемент меньше предыдущего, то
            if(pv[j] < pv[j - 1])
// меняем данные элементы местами
            {
                swap = pv[j];
                pv[j] = pv[j - 1];
                pv[j - 1] = swap;
            }
// в качестве ответа возвращается указатель на отсортированный массив
    return pv;
}
//---------------------------------------------
// Главная функция всего проекта
//---------------------------------------------
int main()
{
// поддержка русскоязычных диалогов
    setlocale(LC_ALL, "");      
// чтобы каждый раз генерировались новые случайные значения
    srand(time(0));             
// хранит количество элементов исходного массива
    int n;
    cout << "Введите количество элементов массива: ";
// считывание кол-ва элементов вводом с клавиатуры
    cin >> n;
// создаем динамический одномерный массив и выделяем для него память
    int *v = new int[n];
// инициализируем элементы массива случайными значениями
    initVector(v, n);
// выводим элементы вектора на экран пользователя
    printVector(v, n, "Исходный массив: ");
// находим сумму всех элементов массива и выводим ее на экран
    cout << "Сумма элементов массива: " << getSumElemVector(v, n) << endl;
// находим кол-во отрицательных элементов массива и выводим ее на экран
    cout << "Количество отрицательных элементов массива: " << getCountNegativeElem(v, n) << endl;
// сортируем заданный массив методом "пузырька"
    bubbleSortVector(v, n);
// выводим элементы массива на экран после сортировки
    printVector(v, n, "Массив после сортировки: ");
// необходимо не забыть освободить динамическую память из-под массива
    delete []v;                 
// для повышения читабельности
    cout << endl;
// имитация задержки программы
    system("pause");
    return 0;
}

Как влияет улучшенное комментирование на конечную стоимость программы

Да, влияет! Общая стоимость всего проекта удорожается. «Насколько?», - спросите вы. Каждую строчку в формате улучшенного комментирования я оцениваю в 5 рублей (на дворе стоит 2018 год, для справки). Когда цена будет изменена, то это непременно отразится и в этой статье. На текущий период стоимость 1 строки улучшенного комментирования составляет всего 5 рублей.

В приведенной программе проставлено 50 строк комментариев, следовательно, их общая стоимость составит 5 • 50 = 250 рублей.

Возникает закономерный вопрос, а насколько полезны и необходимы подобные комментарии? Во-первых, у вас появляется возможность самостоятельно разобраться с представленным кодом. Во-вторых, вам не потребуется заказывать мою разовую консультацию, чтобы я вам пояснил все труднопонимаемые фрагменты кода. Стоимость моей разовой консультации начинается минимум от 1 000 рублей.

В итоге на данной программе вы сэкономите 750 рублей, если выберите формат улучшенного комментирования и не будете привлекать меня для разбора всех моментов кодирования. Выгода на лицо, не правда ли? Очевидно, что да!

Остались вопросы, недопонимание? Звоните мне на мобильный телефон немедленно!

Если после ознакомления с данной статьей у вас остались какие-то вопросы, вам хочется уточнить какие-то наиболее тонкие моменты, то берите сотовый телефон, набирайте мой контактный номер телефона и задавайте их.

Я имею колоссальнейший успешный опыт выполнения проектов по программированию на заказ для студентов и школьников. Хочется донести до всех следующую мысль: улучшенное комментирование – самый оптимальный вариант с позиции комментирования кода программы, так как код становится достаточно понятным даже новичкам и при этом вы экономите немалые деньги на моей разовой консультации.

А сейчас я предлагаю вашему вниманию небольшой презентационный видеоролик, в котором поясняю все ключевые моменты нашего взаимовыгодного в будущем сотрудничества, когда вы будете заказывать у меня какой-либо проект по программированию под ключ.

Тем, кто мечтает стать профессиональным программистом, зарабатывать хорошие деньги в течение жизни, я настоятельно рекомендую записываться ко мне на частную подготовку, на первый пробный урок.

Я достаточно востребованный репетитор, поэтому действуйте прямо сейчас, так как завтра свободных мест уже может не оказаться.

Смотрите отзывы

Напишите письмо

Закажите работу

Отзывы
моих учеников

Трунин
Сергей

На редкость сильный репетитор, абсолютно компетентен в преподаваемом предмете, знает язык программирования Turbo Pascal просто "насквозь". Было интересно заниматься и очень познавательно, так как в школе мы ничего этого...

Другие статьи из рубрики «Работа репетитора»

Я – профессиональный исполнитель всевозможных проектов по программированию на заказ

Пример программы, использующей улучшенное комментирование

Как влияет улучшенное комментирование на конечную стоимость программы

Остались вопросы, недопонимание? Звоните мне на мобильный телефон немедленно!

Отзывымоих учеников

Самые популярные статьи из других рубрик

Сообщение для пользователя

Ошибка на сайте

Отзывы
моих учеников