📜  什么是缩进、文档和程序维护?

📅  最后修改于: 2021-10-19 08:05:10             🧑  作者: Mango

缩进提高了代码的可读性。它主要用于循环语句、控制结构、函数等内部的代码,因为好的预期代码易于维护且美观。它使代码更具可读性和易于理解。一些编程语言如Python强制缩进而不是使用方括号,它使代码易于阅读和理解。

缩进的一些规则是:

  • 每个嵌套块都应正确缩进并用制表符空格隔开。
  • 所有大括号都应该从新行开始,然后代码在新行的结束大括号之后。

一些良好压痕实践的例子

1.在条件语句中使用缩进。

C++
#include 
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;
}


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


C++
#include 
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;
}


输出:

b is greater than a

2.在循环语句中使用缩进。

C++

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

输出:

GeeksforGeeks
GeeksforGeeks
GeeksforGeeks
GeeksforGeeks
GeeksforGeeks
GeeksforGeeks
GeeksforGeeks
GeeksforGeeks
GeeksforGeeks
GeeksforGeeks

文档

文档是编程的一个非常重要的方面。程序中的良好文档使用户易于阅读和理解代码。这是通过在必要的位置插入注释来完成的,以使代码可读和用户更容易理解。文档基本上是为了让代码的用户即使没有程序员的帮助也能理解它。在代码中添加注释并解释代码行,代码将被很好地记录。

例子:

C++

#include 
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;
}

程序维护

程序制作完成后,将作为软件包进行保存和存储。一段时间后,如果程序需要改进或修改,保存的程序会被修改,因为程序不需要从一开始就制作,这样可以节省精力和时间。因此,修改将仅满足目的。程序维护是这样完成的:

  • 保留最后一个程序。
  • 修改程序以进行所需的改进。
  • 不要从头开始制作新程序,只需使用上次保存的程序即可。
  • 节省时间和精力。