8.3-写代码必须要写注释吗？（为什么现实中不写注释？）

一、写代码要写注释

“写代码要写注释”自从学编程，这就话就伴随着你。可见注释的重要性。
注释的作用：

• 说明函数的功能
• 说明函数参数的意思
• 说明函数这样设计的原理（计算公式）
• 说明函数的使用场景
• 作者和日期
• 说明变量的作用
• 函数调用方法与注意事项

总之为了能让读这个函数的人明白这个函数的功能，可以注释各种各样的信息。而没有这些注释文字，就不太容易看懂函数的功能与调用用方法。没有注释的情况下，隔一段时间之后，自己也看懂的自己所写函数的功能了。因此，很多书籍、老师、领导、同事、包括你自己，都会告诉你“一定要写注释，不写是万万不能的”。

二、注释标准格式

其实注释没有特别严格的注释格式，但是为了使得注释整齐简洁。还是会有一些格式的要求的。针对不同开发平台，不同编程语言，都有各自不同的注释推荐格式。（高级一些IDE会提供注释快捷键）下面分别列举一些常见的注释格式：

1. C#

/// <summary>
/// 这个方法的作用就是求两个整数之间的最大值
/// </summary>
/// <param name="n1">第一个整数</param>
/// <param name="n2">第二个整数</param>
/// <returns>返回比较大的那个数字</returns>
public static int GetMax(int n1, int n2) {}

2. Qt_C++

/*
 * @Brief:  
 * @Param:  First
 * @Param:  Second
 * @Return: NULL
 */
 void DataManager::SaveValue(int First, int Second) {
   }

3. Java

/**
* This method inputs a number from the user.
* @return The value output as a double.
* @exception IOException On input error.
*/
public double getNumber() throws IOException {}

4. 单片机中的C语言（格式1）

/*
******************************************************************************************
*	函 数 名: TMC26X_ReadWriteByte
*	功能说明: TMC26X读写一个字节函数
*	形    参: val写入值
*	返 回 值: 读回状态值
******************************************************************************************
*/
UINT8 TMC26X_ReadWriteByte(UINT8 val)