C 语言:注释
本文章通过语法和示例说明了如何在 C 语言中使用注释。更多C教程请访问码农之家
描述
在 C 编程语言中,您可以在源代码中放置不作为程序一部分执行的注释。
注释使 C 源代码更清晰,使其他人能够更好地理解代码的目的,并极大地帮助调试代码。注释在包含数百或数千行源代码的大型项目中或在许多贡献者正在处理源代码的项目中尤其重要。
注释以斜杠星号开头,以星/*
号斜杠结尾,*/
可以在程序中的任何位置。注释可以跨越 C 程序中的多行。注释通常直接添加在相关 C 源代码的上方。
强烈推荐在 C 源代码中添加源代码注释。一般来说,过度注释 C 源代码总比添加不足要好。
语法
注释的语法是:
/* comment goes here */
或者
/*
* comment goes here
*/
注意
- 选择一种注释风格并在整个源代码中始终如一地使用它是很重要的。这样做会使代码更具可读性。
示例 - 单行注释
您可以在单行上创建注释。
例如:
/* Author: TechOnTheNet.com */
C++ 引入了双斜杠注释前缀//
作为注释单行的一种方式。下面是一个例子:
// Author: TechOnTheNet.com
如果大多数现代 C 编译器也理解 C++ 语言,则可以使用这种形式的注释。
示例 - 注释跨越多行
您可以创建跨越多行的注释。例如:
/*
* Author: TechOnTheNet.com
* Purpose: To show a comment that spans multiple lines.
* Language: C
*/
编译器将假定/*
符号之后的所有内容都是注释,直到到达*/
符号为止,即使它跨越 C 程序中的多行。
示例 - 代码行末尾的注释
您可以创建显示在代码行末尾的注释。
例如:
#define AGE 6 /* This constant is called AGE */
或者
#define AGE 6 // This constant is called AGE
在这些示例中,编译器将定义一个名为 AGE 的常量,其中包含值 6。在定义常量后,可以在代码行的末尾找到注释。