Delphi代码风格约定

 

Delphi代码风格约定

qingrui li 据Charles Calvert的Object Pascal Style Guide编注

注:很多用Delphi的人不注意代码风格,经常写一些不规范的代码,以致别人很难看懂且容易出错。希望本文能鼓励广大Delphi爱好者统一到标准风格,共同前进。

本文描述了格式化Delphi代码的标准风格。次风格基于Delphi开发组的编码约定。我们承认很多流行的源码使用了不同于我们的风格,但是我们强烈推荐在公共源码社区使用Borland风格。

Delphi是个漂亮的语言,优点中重要的一条即是可读性。本标准为增强可读性设计。当开发者遵循本标准,所有开发者将从统一易读的风格中受益。强化风格标准的努力可以提高源程序的价值,尤其在调试和维护周期。

InfixCaps命名风格

又叫CamelCaps,名字由几个表达意义的词组成,每个词的首字母大写,其余小写。

如:MyFile,IntToStr,Items。

Delphi不使用匈牙利表示法,而推荐意义明确的名字。如用AppName而非lpszAppName,用Successful而非bSuccess,用ClientRect而非lprectClientRect。

源文件命名

使用InfixCaps形式。如果转译C/C++头文件,则使用与原头文件相同的名字。如果需要将多个头文件合并到一个单元,则使用主要头文件的名字,如:WinBase.h、Windows.h合并为Windows.pas。

命名约定

除了保留字和指示字全部小写,其它标识符使用InfixCaps风格。

注:最近似乎倾向于局部变量和形式参数使用简单的小写或缩写词。

例外是转译头文件的标识符保留原风格。

类型名都以T打头(Type的首字母)

函数、过程、方法名使用动词或动词短语,其它标识符使用名词或名词短语。

类数据成员以F打头(Field的首字母)

枚举类型成员前冠以小写的类型缩写,一般两个字母,例:

  TBitBtnKind = (bkCustom, bkOK, bkCancel, bkHelp, 
    bkYes, bkNo, bkClose, bkAbort, bkRetry, 
    bkIgnore, bkAll);

返回布尔值的函数以Is打头,例:IsVisible、IsResizable

空白的使用

在适当位置插入空行,分隔代码的不同部分,如类声明间、函数实现间等。

使用空格的位置:标点的右边,二元运算符的两边

不应插入空格的位置:

  1. 方法名和其后的左括弧间
  2. .的前后
  3. 一元运算符和其操作数间
  4. 左括弧后和右括弧前
  5. 分号前

正确的例子:

function TMyClass.MyFunc(var Value: Integer);
MyPointer := @MyRecord;
MyClass := TMyClass(MyPointer);
MyInteger := MyIntegerArray[5];

错误的例子:

function TMyClass.MyFunc( var Value: Integer ) ;
MyPointer := @ MyRecord;
MyClass := TMyClass ( MyPointer ) ;
MyInteger := MyIntegerArray [ 5 ] ;

缩进

应使用两个空格的缩进,不要使用Tab字符。

begin...end间的代码要缩进,begin...end本身不缩进

续行时缩进两个空格

正确的例子:

function CreateWindowEx(dwExStyle: DWORD; 
  lpClassName: PChar; lpWindowName: PChar; 
  dwStyle: DWORD; X, Y, nWidth, nHeight: Integer;
  hWndParent: HWND; hMenu: HMENU; hInstance: HINST; 
  lpParam: Pointer): HWND; stdcall;

if ((X = Y) or (Y = X) or
  (Z = P) or (F = J) then
begin
  S := J;
end;
while (LongExpression1 or LongExpression2) do 
begin
  // DoSomething
  // DoSomethingElse;
end;

if (LongExpression1) or 
  (LongExpression2) or 
  (LongExpression3) then 

类声明安下列顺序组织

  • 数据域

  • 方法

  • 属性

访问层次安下列顺序组织,但IDE自动生成的代码是例外

  • Private declarations
  • Protected declarations
  • Public declarations
  • Published declarations

构造函数和析构函数声明在方法声明的前面。由于TObject.Destroy是虚函数且TObject.Free调用的是Destroy,所以析构函数不要用其它的名字。构造函数可以用除Create外的名字,但一般最好统一用Create。

例:

  TMyClass = class(TObject)
  private
  protected
  public
  published
  end;

数据应该只在私有部分声明,并以F打头(Field的首字母)。

type
  TMyClass = class(TObject)
  private
    FMyData: Integer;
    function GetData: Integer;
    procedure SetData(Value: Integer);
  public
  published
    property MyData: Integer read GetData write SetData;
  end;

接口遵循相同规则

  • 0
    点赞
  • 0
    评论
  • 0
    收藏
  • 一键三连
    一键三连
  • 扫一扫,分享海报

打赏
文章很值,打赏犒劳作者一下
相关推荐
<p style="text-align:left;"> <span> </span> </p> <p class="ql-long-24357476" style="font-size:11pt;color:#494949;"> <span style="font-family:"color:#E53333;font-size:14px;background-color:#FFFFFF;line-height:24px;"><span style="line-height:24px;">限时福利1:</span></span><span style="font-family:"color:#3A4151;font-size:14px;background-color:#FFFFFF;">购课进答疑群专享柳峰(刘运强)老师答疑服务。</span> </p> <p> <br /> </p> <p class="ql-long-24357476"> <strong><span style="color:#337FE5;font-size:14px;">为什么说每一个程序员都应该学习MySQL?</span></strong> </p> <p class="ql-long-24357476"> <span style="font-size:14px;">根据《2019-2020年中国开发者调查报告》显示,超83%的开发者都在使用MySQL数据库。</span> </p> <p class="ql-long-24357476"> <img src="https://img-bss.csdn.net/202003301212574051.png" alt="" /> </p> <p class="ql-long-24357476"> <span style="font-size:14px;">使用量大同时,掌握MySQL早已是运维、DBA的必备技能,甚至部分IT开发岗位也要求对数据库使用和原理有深入的了解和掌握。</span><br /> <br /> <span style="font-size:14px;">学习编程,你可能会犹豫选择 C++ 还是 Java;入门数据科学,你可能会纠结于选择 Python 还是 R;但无论如何, MySQL 都是 IT 从业人员不可或缺的技能!</span> </p> <span></span> <p> <br /> </p> <p> <span> </span> </p> <h3 class="ql-long-26664262"> <p style="font-size:12pt;"> <strong class="ql-author-26664262 ql-size-14"><span style="font-size:14px;color:#337FE5;">【课程设计】</span></strong> </p> <p style="font-size:12pt;"> <span style="color:#494949;font-weight:normal;"><br /> </span> </p> <p style="font-size:12pt;"> <span style="color:#494949;font-weight:normal;font-size:14px;">在本课程中,刘运强老师会结合自己十多年来对MySQL的心得体会,通过课程给你分享一条高效的MySQL入门捷径,让学员少走弯路,彻底搞懂MySQL。</span> </p> <p style="font-size:12pt;"> <span style="color:#494949;font-weight:normal;"><br /> </span> </p> <p style="font-size:12pt;"> <span style="font-weight:normal;font-size:14px;">本课程包含3大模块:</span><span style="font-weight:normal;font-size:14px;"> </span> </p> </h3> <p class="ql-long-26664262" style="font-size:11pt;color:#494949;"> <strong class="ql-author-26664262"><span style="font-size:14px;">一、基础篇:</span></strong> </p> <p class="ql-long-26664262" style="font-size:11pt;color:#494949;"> <span class="ql-author-26664262" style="font-size:14px;">主要以最新的MySQL8.0安装为例帮助学员解决安装与配置MySQL的问题,并对MySQL8.0的新特性做一定介绍,为后续的课程展开做好环境部署。</span> </p> <p class="ql-long-26664262" style="font-size:11pt;color:#494949;"> <span class="ql-author-26664262" style="font-size:14px;"><br /> </span> </p> <p class="ql-long-26664262" style="font-size:11pt;color:#494949;"> <strong class="ql-author-26664262"><span style="font-size:14px;">二、SQL语言篇</span></strong><span class="ql-author-26664262" style="font-size:14px;">:</span> </p> <p class="ql-long-26664262" style="font-size:11pt;color:#494949;"> <span class="ql-author-26664262" style="font-size:14px;">本篇主要讲解SQL语言的四大部分数据查询语言DQL,数据操纵语言DML,数据定义语言DDL,数据控制语言DCL,</span><span style="font-size:14px;">学会熟练对库表进行增删改查等必备技能。</span> </p> <p class="ql-long-26664262" style="font-size:11pt;color:#494949;"> <span style="font-size:14px;"><br /> </span> </p> <p class="ql-long-26664262" style="font-size:11pt;color:#494949;"> <strong class="ql-author-26664262"><span style="font-size:14px;">三、MySQL进阶篇</span></strong><span style="font-size:14px;">:</span> </p> <p class="ql-long-26664262" style="font-size:11pt;color:#494949;"> <span style="font-size:14px;">本篇可以帮助学员更加高效的管理线上的MySQL数据库;具备MySQL的日常运维能力,语句调优、备份恢复等思路。</span> </p> <span><span> <p style="font-size:11pt;color:#494949;"> <span style="font-size:14px;"> </span><img src="https://img-bss.csdn.net/202004220208351273.png" alt="" /> </p> </span></span>
本套餐将包括两个重磅性的课程与一个赠送学习的课程,分别为SpringBoot实战视频教程与RabbitMQ实战教程跟SSM整合开发之poi导入导出Excel。目的是为了让各位小伙伴可以从零基础一步一个脚印学习微服务项目的开发,特别是SpringBoot项目的开发,之后会进入第二个课程:RabbitMQ的实战,即消息中间件在实际项目或者系统中各种业务模块的实战并解决一些常见的典型的问题!核心的知识点分别包括 一、SpringBoot实战历程课程 (1)SpringBoot实战应用场景的介绍与代码实战 (2)发送邮件服务、上传下载文件服务、Poi导入导出Excel (3)单模块与多模块项目构建、项目部署打包、日志、多环境配置、lombok、validator以及mybatis整合实战跟多数据源实战 (4)Redis缓存中间件的实战与缓存雪崩跟缓存穿透等问题的解决实战 (5)RabbitMQ消息中间件在业务模块异步解耦、通信、消息确认机制以及并发量配置等的实战 二、RabbitMQ实战教程课程 (1)RabbitMQ的官网权威技术手册拜读,认识并理解各大专有名词,如队列,交换机,路由,死信队列,消息确认机制等等 (2)RabbitMQ在业务服务模块之间的异步解耦通信实战,如异步记录日志与发送邮件等 (3)商城系统抢单高并发情况下RabbitMQ的限流作用与代码实战 (4)消息确认机制与并发量配置并用来实战商城用户下单 (5)死信队列深入讲解与DLX,DLK,TTL等概念的讲解并用来实战 “支付系统用户下单后支付超时而失效其下单记录”实战 详情,各位小伙伴可以查看两个课程的目录。相信学完该套餐相关课程后,你的实战能力将大大提升!涨薪将不再遥遥无期! 最后,赠送的SSM整合开发之POI导入导出Excel目的是为了让各位小伙伴也可以学习Spring+SpringMVC+Mybatis整合开发的项目,让大家一对比SpringBoot与SPring的项目开发流程以及复杂程度!!! 相信学完之后,你会对SpringBoot爱不释手!!
近年来,物联网的发展势不可挡,将很快成为下一个革命性的技术变革,改变人们的生活方式。而嵌入式linux相关技术则是物联网技术中的核心部分(感知层和传输层全部依赖嵌入式技术的支撑),想要在物联网技术中有所建树嵌入式linux是绕不开的一道坎,因此为广大相关专业大学生和相关行业工程师所关注。然后传统的线下培训班学习方式却有着诸多缺陷:费用高昂(4个月16800元左右)、时间和空间成本高昂(必须全日制集中式脱产学习、学习和生活成本高)、效果差(老师水平、责任心、教学管理水平参差不齐)等,让人望而却步、“嵌入式,想说爱你不容易”。 本课程是从零开始完整系统的学习嵌入式linux技术的完全教程,因此学习是分为几个阶段的,每个人应当根据自己的情况选择合适的学习起始点(譬如有基础则可不必从头开始)和学习重点安排(譬如有些人应该重点看C,而有些人要重点看裸机等)。 但是总的来说,大部分同学的基础和学习能力都相差不大,因此我下面给出的完整学习路径和建议适合99%的同学。这个学习路线也是朱老师课程录制和顺序,也是朱老师自己认为的合理的学习进阶路线,建议大家参考该路线学习,以大限度提升学习效率。 第0阶段:试学阶段 本阶段要学习的课程是《0.基础预科》中的3个课程。学习顺序为: 先学习《0.1.嵌入式软件工程师完全学习指南》。本课程是对物联网技术的介绍,和朱老师整个物联网相关课程的大规划(嵌入式linux核心课程属于朱老师整个物联网课程体系的一部分,其他部分还有诸如Android扩展、物联网传感器扩展等)。学完本课程可对物联网的概念和应用有更深的理解,尤其适合根本不理解何为物联网的小白学习。(现在很多大学都开设物联网专业,但是都大二大三了都还不知道何为物联网的人一大堆,甚至学校老师都说不清到底什么是物联网) 然后学习《0.2.朱老师带你零基础学Linux》,本课程是对linux系统的基本使用。因为之后的所有开发都是在linux系统(具体的说是ubuntu,更具体点是基础预科里用的是ubuntu10.04,后面其他课程里用的是ubuntu14.04)中进行的,因此要开始学习必须先会使用linux发行版系统,所以这个课必须先学。 后是《0.3.嵌入式linux C编程基础》,这个课程是非常非常基础的讲C语言的课程(其实还只讲了一半,是线下实体课堂的实录,因为当时课上到一半开班了所以就没继续讲了)。这个课程C语言讲的非常仔细,仔细到令人发指的程度。如果你C语言功底不行建议好好看这个课程,会有极大提升。当然如果C语言还可以,有一定功力(表现为看了这个课程后感觉太简单太容易了),那这个课程可以快进过去或者干脆跳过。 至此基础预科学习完毕,可以正式开启嵌入式linux学习之路了。 多说几句,整个《0.基础预科》部分的视频课程都是免费提供的。并不是说这部分课程没有含金量所以免费,相反这部分课程含金量很高(同学反馈的好评也多)。朱老师之所以将本部分定为免费课程,主要是希望大家能够零成本的开始学习,先通过这部分课程的学习检验自己的学习结果,搞清楚以下问题: 我到底能不能学会? 这个课程到底适合不适合我,这个老师的风格我到底喜欢不喜欢? 这个技术方向到底能不能吸引我?我是不是真的决定去学嵌入式了? 这老师行不行?值不值得花钱买他的课程? 把这个阶段定位为试学阶段,也是基于这点。试学,一方面试的是你自己,另一方面试的是我。试学阶段40小时左右的课程(其实本来可以短一些的)大家至少需要一周以上才能学完,这么久的时间就是希望大家能够想清楚,也能够看清楚自己的内心兴趣,同时也能充分检验朱老师的课程质量。 第1阶段:初级嵌入式软件工程师阶段 本阶段的学习内容包括《1.ARM裸机全集》和《4.C语言专题》这两个课程。学习顺序是以ARM裸机为主线,其中穿插C语言专题进行学习。 本阶段2个大课程加起来156小时,主体内容是嵌入式linux软件开发方向的各种零碎知识点和能力点,几乎可以认为是整个课程中重要的一个阶段(有些人说驱动重要?这两个阶段如果过不了驱动跟你半毛钱关系都没有)。 本阶段对大家重要还有个更主要原因就是:本课程中讲的东西都是各种嵌入式软件开发岗位技术面试笔试中常遇到的。所以如果是希望通过学习搞定面试找到工作,那本阶段的课程就要作为重点学(尤其是C语言专题)。 第2阶段:提升阶段 本阶段的学习内容包括《2.uboot和linux内核移植》和《3.linux应用编程和网络编程》。其中uboot和系统移植承接ARM裸机阶段内容,继续讲解uboot。这个课程也很精华,分为20个小课程一共92小时,学习本课程并且把课程中的练习都做下来后,整个人的程序编写和调试功能会极大提升,用已经学完的同学的话讲是“感觉整个人脱胎换骨了”。Linux应用编程和网络编程这个课程根据APUE这本书简化而来,面向实际用到的知识点和重点,学起来难易适中,相对轻松点。不过却是后面学习驱动的,想要写驱动必须得先会写应用,这个道理大家一定要遵从。 本阶段的2个课程之间没有先后顺序,大家可以根据自己的需要来安排。我讲课时是按照先uboot和系统移植,后linux应用编程和网络编程的。(主要是为了承接前后阶段) 第3阶段:驱动学习阶段 本阶段内容为《5.linux驱动开发》,本部分是整个课程里大家期待的部分,很多人是一上来就想学习驱动开发的。但是必须认识到,驱动是linux技术中集大成者,前面所有课程中学到的内容在驱动中都会用到,驱动编程和调试是让人抓掉头发都无从下手的麻烦事,所以建议大家学好前面的课程再来看本部分,否则你将什么都得不到。(就好像笑话里说的那种,前面4碗饭不吃,直接吃第5碗也是不可能饱的) 第4阶段:项目阶段 本阶段为大家安排了一个练习项目,该项目综合用到了前面课程中讲到的知识和能力,包括驱动和应用,编程能力、调试能力等。为了方便本项目并未用到额外的配件,课程配套的X210开发板即可直接完成项目。本项目只是个开胃小菜,用来给大家检验自己的学习成果的而已。 真正有用而复杂的项目,朱老师将在另一个课程体系(暂定名为:朱有鹏老师物联网项目库)中给大家一一道来。这些项目会从2016.8左右开始一直持续(直到朱老师退休······),朱老师的目标是将常见的各种物联网传感器、外设硬件模块、前端技术应用都囊括进来,使用我们嵌入式linux核心课程中学到的编程能力,结合这些软硬件模块来完成一个又一个大项目小项目。将来大家可以根据自己的兴趣爱好和工作需要,在其中选择合适的项目进行学习,并且即刻在实际中遇到这些项目(也是是为了毕业设计、也许是公司下一个产品···)
©️2020 CSDN 皮肤主题: 大白 设计师:CSDN官方博客 返回首页

打赏

Nightmare

你的鼓励将是我创作的最大动力

¥2 ¥4 ¥6 ¥10 ¥20
输入1-500的整数
余额支付 (余额:-- )
扫码支付
扫码支付:¥2
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值