当前位置 > 主页 > 传奇百科 >

可调试代库的编指南

时间:2019-07-16 13:22 作者:七六搜服 来源:http://www.76sf.com
导读: 维护代库六年是一项艰巨的任务,如果你没有尽早开始为你的编指南创建约定和范例,特别是如果你的程序员有波动(工作学生,退休人员,职业者,...... )。多年来,大约12位不同经验的程序员为我们的代库做出了贡献。虽然与同事一起进行代审查是向其他(初级)

维护代库六年是一项艰巨的任务,如果你没有尽早开始为你的编指南创建约定和范例,特别是如果你的程序员有波动(工作学生,退休人员,职业者,...... )。多年来,大约12位不同经验的程序员为我们的代库做出了贡献。虽然与同事一起进行代审查是向其他(初级)程序员传授编指南的好机会,但听取同事的意见也很重要。事实上,在我10年的编中,我从来没有经历过至少一次没有被破坏的单一指南,但总是有充分的理由。你应该知道原因,甚至可能会调整你的指导方针。

编风格

我们的指导原则的主要原因是创建可读且易于调试的代,即没有太复杂的指令或方程式,并且试图不将变量隐藏在对调试很重要的指令中。这当然不会产生最好的或最优化的代,但这比让某人不了解如何修复错误甚至引入新错误要好得多。

当我获得开放程序员职位的申请时,一件令我恼火的事情是用非英语语言查找代。有一件事是,有时几乎不可能阅读一些代(不,我不能读中文,俄文,......变量名)。我们在团队中偶然发现的另一件事是,如果人们谈论同样的事情,但用他们自己的语言(我们的公司位于德国)用不同的方式命名,那只是令人困惑。因此,英语一直用于代,评论和(技术)文档,以避免混淆。

我将指南分为三类:

在实际编写代之前要考虑的一般指南。C#specific,这是编写任何C#代的指南。特定于Unity,这是为了避免在为Unity3D编写时遇到一些陷阱。

同样,所有的指导方针都没有成立!如果有一个很好的理由打破一个,所有人都必须知道为什么,这对每个人都没问题。最重要的是,所有程序员都对指南很好,并且他们为整个团队工作。

让我们来看看指南:

一般编语言是英语。类,变量,函数和方法名称都是英文的,以及所有书面注释或标题信息。使用空格而不是制表符(这样每个其他计算机上的代看起来都一样)。标签是4个空格。变量和函数的名称应该是描述的。长名称没有问题,名字不详。只有在非常清楚且众所周知的情况下才使用缩写。没有匈牙利语符号。每个逗号都跟一个空格(例如 myFunction(int a,int b,int c))。使用逗号来提高可读,但将其保留为逗号(例如 add(1 + 2)而不是 add(1 + 2))。避免上大班。将辅助类的通用能提取出来。单个类文件不应超过500行。写短函数,最好不要超过100行。不要写出比普通1920 * 1080屏幕更长的线条。生成DRY代。 (https://en..org/wiki/Don%27t_repeat_yourself)保持松散的类耦合。 (https://en..org/wiki/Law_of_Demeter)写能尽可能的能。 (http://www.gamasutra.com/view/news/169296/Indepth_Functional_programming_in_C.php)。编写函数将使分离逻辑和保持较小的类更容易。仅在需要时使用代注释(例如,在破坏其中一个编约定规则时)。代应该说明一切,评论它主要意味着它写得太难理解。在为以后的工作添加注释时,请写“TODO:”;并以括号中的首字母结尾(例如“TODO:稍后清理(PH)”)不要禁用错误和警告消息。使用回调委托时,请尝试包含成和失败的结果。避免使用“魔术数字” (https://en..org/wiki/Magic_number_(programming)#Unnamed_numerical_constants)。如果需要常量值,则必须在类的顶部声明它们。在自己的分支上工作时,经常从主/开发人员分支更新您的分支以保持最新并避免大的合并冲突。提交小块更改而不是大量提交。使审查和还原更容易。C#具体每个类,接口,结构,枚举都在自己的文件中实现。只有cla

维护代库六年是一项艰巨的任务,如果你没有尽早开始为你的编指南创建约定和范例,特别是如果你的程序员有波动(工作学生,退休人员,职业者,...... )。多年来,大约12位不同经验的程序员为我们的代库做出了贡献。虽然与同事一起进行代审查是向其他(初级)程序员传授编指南的好机会,但听取同事的意见也很重要。事实上,在我10年的编中,我从来没有经历过至少一次没有被破坏的单一指南,但总是有充分的理由。你应该知道原因,甚至可能会调整你的指导方针。

编风格

我们的指导原则的主要原因是创建可读且易于调试的代,即没有太复杂的指令或方程式,并且试图不将变量隐藏在对调试很重要的指令中。这当然不会产生最好的或最优化的代,但这比让某人不了解如何修复错误甚至引入新错误要好得多。

当我获得开放程序员职位的申请时,一件令我恼火的事情是用非英语语言查找代。有一件事是,有时几乎不可能阅读一些代(不,我不能读中文,俄文,......变量名)。我们在团队中偶然发现的另一件事是,如果人们谈论同样的事情,但用他们自己的语言(我们的公司位于德国)用不同的方式命名,那只是令人困惑。因此,英语一直用于代,评论和(技术)文档,以避免混淆。

我将指南分为三类:

在实际编写代之前要考虑的一般指南。C#specific,这是编写任何C#代的指南。特定于Unity,这是为了避免在为Unity3D编写时遇到一些陷阱。

同样,所有的指导方针都没有成立!如果有一个很好的理由打破一个,所有人都必须知道为什么,这对每个人都没问题。最重要的是,所有程序员都对指南很好,并且他们为整个团队工作。

让我们来看看指南:

一般编语言是英语。类,变量,函数和方法名称都是英文的,以及所有书面注释或标题信息。使用空格而不是制表符(这样每个其他计算机上的代看起来都一样)。标签是4个空格。变量和函数的名称应该是描述的。长名称没有问题,名字不详。只有在非常清楚且众所周知的情况下才使用缩写。没有匈牙利语符号。每个逗号都跟一个空格(例如 myFunction(int a,int b,int c))。使用逗号来提高可读,但将其保留为逗号(例如 add(1 + 2)而不是 add(1 + 2))。避免上大班。将辅助类的通用能提取出来。单个类文件不应超过500行。写短函数,最好不要超过100行。不要写出比普通1920 * 1080屏幕更长的线条。生成DRY代。 (https://en..org/wiki/Don%27t_repeat_yourself)保持松散的类耦合。 (https://en..org/wiki/Law_of_Demeter)写能尽可能的能。 (http://www.gamasutra.com/view/news/169296/Indepth_Functional_programming_in_C.php)。编写函数将使分离逻辑和保持较小的类更容易。仅在需要时使用代注释(例如,在破坏其中一个编约定规则时)。代应该说明一切,评论它主要意味着它写得太难理解。在为以后的工作添加注释时,请写“TODO:”;并以括号中的首字母结尾(例如“TODO:稍后清理(PH)”)不要禁用错误和警告消息。使用回调委托时,请尝试包含成和失败的结果。避免使用“魔术数字” (https://en..org/wiki/Magic_number_(programming)#Unnamed_numerical_constants)。如果需要常量值,则必须在类的顶部声明它们。在自己的分支上工作时,经常从主/开发人员分支更新您的分支以保持最新并避免大的合并冲突。提交小块更改而不是大量提交。使审查和还原更容易。C#具体每个类,接口,结构,枚举都在自己的文件中实现。只有cla

上一篇:2011年愚人节综述

下一篇:花生如何利用Marcie探索不健康的关系