Что такое отступы, документация и сопровождение программы?

Опубликовано: 10 Июня, 2021

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

Некоторые правила для отступов:

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

Пример хорошей практики использования отступов

1. Использование отступов в условных операторах.

C ++

 #include <iostream>
 using namespace std;
 
int main()
 {
    int a = 10, b = 20;
    if (a > b) {
        cout << "a is greater than b" ;
    }
    else {
        cout << "b is greater than a" ;
    }
    return 0;
 }

Выход:

b больше, чем a

2. Использование отступов в операторах цикла.

C ++

 #include <iostream>
 using namespace std;
 
int main()
 {
    for ( int i = 0; i < 10; i++) {
        cout << "GeeksforGeeks"
             << "
" ;
    }
    return 0;
 }

Выход:

 Гики
Гики
Гики
Гики
Гики
Гики
Гики
Гики
Гики
Гики

Документация

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

Пример:

C ++

 #include <iostream>
 using namespace std;
 
// Main function
 int main()
 {
    // Initializing variable a by 10 and b by 20
    int a = 10, b = 20;
   
    // If a is greater than b go inside if block
    if (a > b) {
       
        // Print a is greater than b
        cout << "a is greater than b" ;
    }
   
    // If a is not greater than b go in else block
    else {
       
        // Print b is greater than a
        cout << "b is greater than a" ;
    }
   
    // End of main function
    return 0;
 }

Сопровождение программы

После того, как Программа создана, она сохраняется и хранится как пакет программного обеспечения. Через некоторое время, если программа нуждается в улучшении или модификации, сохраненная программа модифицируется и экономит силы и время, поскольку программы не нужно создавать с самого начала. Следовательно, модификации будут соответствовать только цели. Сопровождение программы осуществляется как:

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

Picked Школьное программирование

Что такое отступы, документация и сопровождение программы?

C ++

C ++

Документация

C ++

Сопровождение программы

РЕКОМЕНДУЕМЫЕ СТАТЬИ