王逸玲的算法第一章作业

一.华为公司的编码规范:

1、代码总体原则

(1)清晰第一

(2)简洁为美

(3)选择合适的风格,与代码原有风格保持一致

 

 

2、头文件

对于C语言来说,头文件的设计体现了大部分的系统设计。不合理的头文件布局是编译时间过长的根因,不合理的头文件实际上反映了不合理的设计。

1、编码要求

1)内部使用的函数(相当于类的私有方法)声明不应放在头文件中。

2)内部使用的宏、枚举、结构定义不应放入头文件中。

3)变量定义不应放在头文件中,应放在.c文件中。

4)变量的声明尽量不要放在头文件中,亦即尽量不要使用全局变量作为接口。变量是模块或单元的内部实现细节,不应通过在头文件中声明的方式直接暴露给外部,应通过函数接口的方式进行对外暴露。即使必须使用全局变量,也只应当在.c中定义全局变量,在.h中仅声明变量为全局的。

 

 

2、头文件应当职责单一,切忌依赖复杂

头文件过于复杂,依赖过于复杂是导致编译时间过长的主要原因。很多现有代码中头文件过大,职责过多,再加上循环依赖的问题,可能导致为了在.c中使用一个宏,而包含十几个头文件。

 

3、头文件应向稳定的方向

产品依赖于平台,平台依赖于标准库。某产品线平台的代码中已经包含了产品的头文件,导致平台无法单独编译、发布和测试,是一个非常糟糕的反例。除了不稳定的模块依赖于稳定的模块外,更好的方式是两个模块共同依赖于接口,这样任何一个模块的内部实现更改都不需要重新编译另外一个模块。在这里,我们假设接口本身是最稳定的。

 

4、每一个 .c 文件应有一个同名 .h 文件,用于声明需要对外公开的接口

 

如果一个.c文件不需要对外公布任何接口,则其就不应当存在,除非它是程序的入口,如main函数所在的文件。现有某些产品中,习惯一个.c文件对应两个头文件,一个用于存放对外公开的接口,一个用于存放内部需要用到的定义、声明等,以控制.c文件的代码行数。编者不提倡这种风格。这种风格的根源在于源文件过大,应首先考虑拆分.c文件,使之不至于太大。另外,一旦把私有定义、声明放到独立的头文件中,就无法从技术上避免别人include之,难以保证这些定义最后真的只是私有的。

5、禁止头文件循环依赖

头文件循环依赖,指a.h包含b.hb.h包含c.hc.h包含a.h之类导致任何一个头文件修改,都导致所有包含了a.h/b.h/c.h的代码全部重新编译一遍。而如果是单向依赖,如a.h包含b.hb.h包含c.h,而c.h不包含任何头文件,则修改a.h不会导致包含了b.h/c.h的源代码重新编译。

 

6  .c/.h文件禁止包含用不到的头文件

很多系统中头文件包含关系复杂,开发人员为了省事起见,可能不会去一一钻研,直接包含一切想到的头文件,甚至有些产品干脆发布了一个god.h,其中包含了所有头文件,然后发布给各个项目组使用,这种只图一时省事的做法,导致整个系统的编译时间进一步恶化,并对后来人的维护造成了巨大的麻烦。

 

7  头文件应当自包含

简单的说,自包含就是任意一个头文件均可独立编译。如果一个文件包含某个头文件,还要包含另外一个头文件才能工作的话,就会增加交流障碍,给这个头文件的用户增添不必要的负担。

 

(示例:如果a.h不是自包含的,需要包含b.h才能编译,会带来的危害:每个使用a.h头文件的.c文件,为了让引入的a.h的内容编译通过,都要包含额外的头文件b.h。额外的头文件b.h必须在a.h之前进行包含,这在包含顺序上产生了依赖。)

 

注意:该规则需要与“.c/.h文件禁止包含用不到的头文件规则一起使用,不能为了让a.h自包含,而在a.h中包含不必要的头文件。a.h要刚刚可以自包含,不能在a.h中多包含任何满足自包含之外的其他头文件。

 

8、总是编写内部 #include 保护符( #define  保护)

多次包含一个头文件可以通过认真的设计来避免。如果不能做到这一点,就需要采取阻止头文件内容被包含多于一次的机制。通常的手段是为每个文件配置一个宏,当头文件第一次被包含时就定义这个宏,并在头文件被再次包含时使用它以排除文件内容。所有头文件都应当使用#define 防止头文件被多重包含,命名格式为FILENAME_H,为了保证唯一性,更好的命名是PROJECTNAME_PATH_FILENAME_H

 

注:没有在宏最前面加上单下划线"_",是因为一般以单下划线"_"和双下划线"__"开头的标识符为ANSIC等使用,在有些静态检查工具中,若全局可见的标识符以"_"开头会给出告警。

 

9、禁止在头文件中定义变量

在头文件中定义变量,将会由于头文件被其他.c文件包含而导致变量重复定义。

 

10、只能通过包含头文件的方式使用其他 .c 提供的接口,禁止在.c 中通过 extern 的方式使用外部函数接口、变量。

11、禁止在 extern "C" 中包含头文件

extern "C"中包含头文件,会导致extern "C"嵌套,Visual Studioextern "C"嵌套层次有限制,嵌套层次太多会编译错误。

extern "C"中包含头文件,可能会导致被包含头文件的原有意图遭到破坏。

 

12、一个模块通常包含多个 .c 文件,建议放在同一个目录下,目录名即为模块名。为方便外部使用者,建议每一个模块提供一个 .h ,文件名为目录名。

需要注意的是,这个.h并不是简单的包含所有内部的.h,它是为了模块使用者的方便,对外整体提供的模块接口。以Google test(简称GTest)为例,GTest作为一个整体对外提供C++单元测试框架,其1.5版本的gtest工程下有6个源文件和12个头文件。但是它对外只提供一个gtest.h,只要包含gtest.h即可使用GTest提供的所有对外提供的功能,使用者不必关系GTest内部各个文件的关系,即使以后GTest的内部实现改变了,比如把一个源文件c拆成两个源文件,使用者也不必关心,甚至如果对外功能不变,连重新编译都不需要。对于有些模块,其内部功能相对松散,可能并不一定需要提供这个.h,而是直接提供各个子模块或者.c的头文件。

 

13、如果一个模块包含多个子模块,则建议每一个子模块提供一个对外的 .h,文件名为子模块名。

 

14、头文件不要使用非习惯用法的扩展名,如 .inc

使用.inc会导致source insightVisual stduioIDE工具无法识别其为头文件,导致很多功能不可用,如跳转到变量定义处。虽然可以通过配置,强迫IDE识别.inc为头文件,但是有些软件无法配置,如Visual Assist只能识别.h而无法通过配置识别.inc

 

15、同一产品统一包含头文件排列方式

常见的包含头文件排列方式:功能块排序、文件名升序、稳定度排序。

 

 

3、函数

!整洁函数要求:代码简单直接、不隐藏设计者的意图、用干净利落的抽象和直截了当的控制语句将函数有机组织起来。

 

1、一个函数仅完成一件功能

 

2、重复代码应该尽可能提炼成函数

项目组应当使用代码重复度检查工具,在持续集成环境中持续检查代码重复度指标变化趋势,并对新增重复代码及时重构。当一段代码重复两次时,即应考虑消除重复,当代码重复超过三次时,应当立刻着手消除重复。

 

3、避免函数过长,新增函数不超过 50 (非空非注释行)

函数的有效代码行数,即NBNC(非空非注释行)应当在[150]区间。

(例外:某些实现算法的函数,由于算法的聚合性与功能的全面性,可能会超过50行。)

 

4、避免函数的代码块嵌套过深,新增函数的代码块嵌套不超过4

函数的代码块嵌套深度指的是函数中的代码控制块(例如:ifforwhileswitch等)之间互相包含的深度。每级嵌套都会增加阅读代码时的脑力消耗,因为需要在脑子里维护一个(比如,进入条件语句、进入循环„„)。应该做进一步的功能分解,从而避免使代码的阅读者一次记住太多的上下文。优秀代码参考值:[1, 4]

 

5可重入函数应避免使用共享变量;若需要使用,则应通过互斥手段(关中断、信号量)对其加以保护

可重入函数是指可能被多个任务并发调用的函数。在多任务操作系统中,函数具有可重入性是多个任务可以共用此函数的必要条件。共享变量指的全局变量和static变量。编写C语言的可重入函数时,不应使用static局部变量,否则必须经过特殊处理,才能使函数具有可重入性。

 

6、对参数的合法性检查,由调用者负责还是由接口函数负责,应在项目组/模块内应统一规定。缺省由调用者负责。

 

7、对函数的错误返回码要全面处理

一个函数(标准库中的函数/第三方库函数/用户定义的函数)能够提供一些指示错误发生的方法。这可以通过使用错误标记、特殊的返回数据或者其他手段,不管什么时候函数提供了这样的机制,调用程序应该在函数返回时立刻检查错误指示。

 

8、设计高扇入,合理扇出(小于7)的函数

扇出是指一个函数直接调用(控制)其它函数的数目,而扇入是指有多少上级函数调用它。

 

3、标识符命名与定义

!标识符的命名规则历来是一个敏感话题,典型的命名风格如unix风格、windows风格等,从来无法达成共识。实际上,各种风格都有其优势也有其劣势,而且往往和个人的审美观有关。我们对标识符定义主要是为了让团队的代码看起来尽可能统一,有利于代码的后续阅读和修改,产品可以根据自己的实际需要指定命名风格,规范中不再做统一的规定。

 

1、标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解

 

2、除了常见的通用缩写以外,不使用单词缩写,不得使用汉语拼音

 

较短的单词可通过去掉“元音”形成缩写,较长的单词可取单词的头几个字母形成缩写,一些单词有大家公认的缩写,常用单词的缩写必须统一。协议中的单词的缩写与协议保持一致。对于某个系统使用的专用缩写应该在注视或者某处做统一说明。

3、产品/项目组内部应保持统一的命名风格

Unix likewindows like风格均有其拥趸,产品应根据自己的部署平台,选择其中一种,并在产品内部保持一致。

4、用正确的反义词组命名具有互斥意义的变量或相反动作的函数等

5、尽量避免名字中出现数字编号,除非逻辑上的确需要编号

 

6、标识符前不应添加模块、项目、产品、部门的名称作为前缀

 

7、平台/ / 驱动等适配代码的标识符命名风格保持和平台

 

8、重构/修改部分代码时,应保持和原有代码的命名风格一致

 

9、文件命名统一采用小写字符

 

因为不同系统对文件名大小写处理会不同(如MSDOSWindows系统不区分大小写,但是Linux系统则区分),所以代码文件命名建议统一采用全小写字母命名。

 

10、全局变量应增加“g_” 前缀,静态变量应增加“s_”

 

11、禁止使用单字节命名变量,但允许定义i jk作为局部循环变量

 

12不建议使用匈牙利命名法

 

变量命名需要说明的是变量的含义,而不是变量的类型。在变量命名前增加类型说明,反而降低了变量的可读性;更麻烦的问题是,如果修改了变量的类型定义,那么所有使用该变量的地方都需要修改。

 

13、使用名词或者形容词+名词方式命名变量

 

14、函数命名应以函数要执行的动作命名,一般采用动词或者动词+名词的结构

 

 

二.《数学之美》第一章 文字和语言和数字信息-读后感

总结:语言和数学的产生都是为了同一个目的——记录和传播信息。

 

  1. 1.     信息

(1)   最早的保存信息的方式——用图形表示事物

 

2)信息的传递过程是信息源首先将信息编码形成能够在信道中传播的信息,然后信息经过信道进行传递,最后,接收者需要解码才能获取到信息源需要传递的信息。

 

3)信息的冗余是信息安全的保障。这对信道编码有指导意义。

 

2. 文字和数字

1随着文明的进步,信息量增加,但埃及的象形文字数量不在随着文明的发展而增加,于是概念的第一次概括和归类就开始了。这种概念的聚类,在原理上与今天自然语言处理和机器学习的聚类有很大的相似性。

 

2)文字可以根据上下文除去歧义,但是对上下文建立的概率模型再好,也有失灵的时候。

 

3)翻译这件事之所以能够达成,仅仅是因为不同的文字系统在记录信息上的能力是相同的。

 

4)文字本身的载体是石头还是纸张并不重要,它承载的信息才是最重要的。

 

5)数字是计数系统的基础。

 

6)进位制的发明说明我们的祖先开始懂得编码数量了。

 

7)阿拉伯数字或者说印度数字的革命性不仅在于它的简介有效,而且标志着数字和文字的分离。这在客观上让自然语言的研究和数学在几千年里没有重合的轨迹,而且越走越远。

 

3. 文字和语言背后的数学

1)如果把中文的笔画作为字母,它其实也是一种拼音文字,但是它只是二维的。

 

2)从象形文字到拼音文字是一个飞跃,因为人类在描述物体的方式上,从物体的外表进化到了抽象的概念,同时不自觉地采用了对信息的编码。

 

3)最短编码原理。使用频率高的码长短,使用频率低的码长长。

 

4)在通信时,如果信道较宽,信息不必压缩既可以直接传递;而如果信道很窄,信息在传递前需要尽可能的压缩,然后在接收端进行解压缩。

 

5)古犹太人抄写圣经,要检查每一行、每一列的校验是否正确。

 

6)如果说从字母到词的构词法是词的编码规则,那么语法规则是语言的编码和解码规则。相比较而言,词可以认为是有限而且封闭的集合,而语言则是无限和开放的集合。从数学上讲,对于前者可以有玩呗的编解码规则,而后者则不具备这个特性。因此任何语言都有语法规则覆盖不到的地方。

 

7)一个语言学研究方法的问题:到底是语言对,还是语法对。前者坚持从真实的语句文本(称为语料)出发,而后者坚持从规则出发。

 

4. 小结

由于时间原因只读了第一章,以后的章节会抽出时间研读,请老师见谅~

其实本人对数学的看法,一直是比较难的科目,没有思路的话压根提不上解答,就像编程一样,想不出好的编程方法,那写出来的代码自然就像废纸一样,不能让人眼前一亮。在《数学之美》第一章中,我觉得讲述的更多的是编码的发展历史。今天我们遇到的很多的编码问题,我们的祖先在设计语言之初其实已经遇到了,并且用类似今天的方法解决了。总而言之,学好编码是对我们程序员来说最基本的技能,希望大二的我能更加努力学习编码算法,不让自己失望!

 

posted @ 2021-09-17 07:30  Sandgirl  阅读(113)  评论(0编辑  收藏  举报