C语言编码规范:编写可读性好的程序
需积分: 6 48 浏览量
更新于2024-12-24
收藏 34KB DOC 举报
C语言编码规范
C语言编码规范是编写高质量C语言程序的必要条件,本文档将详细介绍C语言编码规范的相关知识点。
**编码风格**
在编写C语言程序时,需要遵守一定的编码风格,以确保代码的可读性和维护性。以下是编码风格的相关规定:
* 程序块要采用缩进风格编写,缩进的TAB键一个。
* 相对独立的程序块之间、变量说明之后必须加空行。
* 较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
* 循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。
* 若函数或过程中的参数较长,则要进行适当的划分。
**语句编写**
在编写C语言程序时,需要遵守一定的语句编写规则,以确保代码的可读性和维护性。以下是语句编写的相关规定:
* 不允许把多个短语句写在一行中,即一行只写一条语句。
* if、while、for、default、do等语句自占一行。
* 对齐只使用TAB键,不使用空格键。
* 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。
* 程序块的分界符(如C/C++语言的大括号'{'和'}')应各独占一行并且位于同一列,同时与引用它们的语句左对齐。
**注释**
注释是编写高质量C语言程序的重要组成部分。以下是注释的相关规定:
* 一般情况下,源程序有效注释量必须在20%以上。
* 说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其他文件的关系、修改日志等。
* 源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
* 函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。
* 边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有的注释要删除。
* 注释的内容要清楚。
C语言编码规范是编写高质量C语言程序的必要条件,遵守这些规范可以提高代码的可读性和维护性,提高开发效率和代码质量。
327 浏览量
150 浏览量
266 浏览量
2024-04-13 上传
2024-07-19 上传
2024-07-19 上传
2022-07-03 上传
2022-07-01 上传
105 浏览量
zhanglufang1993
- 粉丝: 17
- 资源: 9
最新资源
- npm-snl-domjs
- Ajax-RestClient.zip
- CSS实现的鼠标移动到图片上显示文字说明内容
- csv-obsidian:在Obsidian中编辑CSV文件
- 企业易站EES v2.11 beta 3.zip
- 撰写样本:Jetpack官方撰写样本
- Stonks:Stonks-Discord的开源生活游戏bot
- MyResource:iOS动手练习小项目
- 简洁多边形商业融资计划书PPT模板
- Ajax-log-listener.zip
- jdk api 1.8_资源合集.zip
- SIM7000-LTE-Shield:具有GNSS和温度传感器的LTE CAT-MNB-IoT Arduino兼容保护罩。 库支持SIMCom 2G3G4G LTECAT-MNB-IoT
- 水星蒙特哥:水星蒙特哥计划
- ghetto-skype:Web Skype +托盘图标+通知
- m3u8 视频在线提取下载工具 支持转MP4格式 HTML源码
- java.util源码-java-util:javautil源代码