论坛首页 入门技术论坛

2.源代码格式

浏览 1303 次
精华帖 (0) :: 良好帖 (0) :: 新手帖 (0) :: 隐藏帖 (1)
作者 正文
   发表时间:2008-12-11   最后修改:2008-12-11
源代码是软件的一个重要的组成部分,源代码格式不对,换句话说,源代码错误,肯定是软件错误。所以,把源代码编译没有错误等价为源代码正确,是错误的,把运行没有错误,等价为源代码正确,是错误的。

源代码格式的几点应该注意的事项(常识):
1、源代码的书写格式,应该体现源代码内部的逻辑关系;
2、源代码内部最重要的代码行是:空行;空行把代码分成各个相对独立的组成部分;
3、源代码内部第二重要的代码行是:注释行;
4、源代码行内最重要的字符是:空格;空格把代码行分成各个相对独立的组成部分;
5、源代码行内第二重要的字符是:制表符(Tab),制表符是行首缩进使用的字符;
6、注释合格的标准是:同等级技术能力的技术人员,可用比较方便的看懂代码;或者,应该从事该工作的技术人员可以容易的看懂;
7、注释行数应该占到总代码行数的三分之一;
8、每个源代码文件头部都必须有说明本文件功能的注释;
9、自己定义的每个函数都必须有说明函数功能的注释;
10、自己定义的每个变量都必须有说明变量功能的注释;
11、注释应该使用自己的母语(汉语);
12、一句注释合格的标准是,表达了需要表达的内容,语法正确;
13、清楚的注释能够方便代码阅读者理解代码的逻辑关系和各个函数的功能;
14、键盘上最重要的键是空格键,空格占英文文章的比例是20%左右;写软件源代码时,空格的比例也很大;所以,键盘上面积最大的键是空格;
论坛首页 入门技术版

跳转论坛:
Global site tag (gtag.js) - Google Analytics