Поверхностное комментирование кода программы

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

Содержание:

Давайте знакомиться! Я - ваш помощник в мире информатики и программирования

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

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

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

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

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

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

Предлагаю рассмотреть постановку задачи с последующей программной реализацией на языке программирования С++. На данном примере я продемонстрирую, что следует понимать под поверхностным комментированием кода программы.

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

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

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

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

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

// для запуска из Visual Studio

#include "stdafx.h"     

// для ввода-вывода информации

#include <iostream> 

// для задач, связанных с локализацией    

#include <locale>       

// для использования манипуляторов ввода-вывода

#include <iomanip>      

using namespace std;    

//---------------------------------------------

// Заполнение элементов массива случайными значениями из отрезка [-20 .. 50]

//---------------------------------------------

void initVector(int *pv, const int pn)

{

    for(int i = 0; i < pn; i++)

        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++)

        cout << setw(5) << pv[i];

    cout << endl << endl;

}

//---------------------------------------------

// Нахождение суммы элементов массива

//---------------------------------------------

int getSumElemVector(int const *pv, const int pn)

{

    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++)

        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;

}

//---------------------------------------------

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

Хочу вас обрадовать! Подобные комментарии в своих проектах по программированию я проставляю абсолютно бесплатно. Это занимает от $2$ до $3$ минут, поэтому, считаю, что могу позволить себе проделать данную работу безвозмездно.

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

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

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

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

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

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

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