代码规范须知_V1.0_20140703
发布日期:2021-08-16 13:28:06 浏览次数:70 分类:技术文章

本文共 2620 字,大约阅读时间需要 8 分钟。

                          代码规范须知

 

现在大家使用的开发工具多种多样,公司暂时没有对开发工具做出硬性指标,总的原则还是个人哪种工具使用的顺手,那么就使用哪种。

虽然可以让大家自由使用各种开发工具,但是还是有一些基本的原则需要大家共同遵守:1、使用空格代替TAB键,TAB键为4个空格长度;2、文件格式必须为Unix格式,不管新建还是修改,不允许为Windows格式;3、文件的编码使用UTF-8。

为什么要做这些硬性规定呢?下面首先讲下原因,然后会出各种主流开发工具(Intellij IDEA、Notepadd++、Vim、Eclipse、Source Insight、Beyond Compare等)的具体怎么配置。

先说下“使用空格键代替TAB,并规定TAB键为4个空格长度”这个规定。这是因为不同的开发工具或者代码浏览工具对于TAB的长度定义可能不一致,有的开发工具中把TAB当做四个空格,也有工具将TAB当做两个空格,那么同样的代码,在这种开发工具下可能显示的格式看起来很工整,而在另一种工具中,则会出现排版错位的情况,影响代码阅读与问题排查。另外,在某些有可视化工具中,TAB键与空格键的显示样式不一致,TAB一般显示为箭头,而空格键显示为圆点,代码中同时存在TAB键与空格键会导致代码显示看起来很糟糕。

“文件格式必须为Unix格式”,提出该规范的最主要原因是,我们现在使用Git仓管理代码。如果把Unix格式的文件修改为Windows格式进行提交,那么这次提交其实是在服务器端首先删除Unix格式的文件,然后添加Windows格式的文件,这样会导致从GIT网页上看不出来你到底修改了什么,不利于后续问题的追踪。其次,如果提交Windows格式的文件,那么以后每次新修改内容的每行末尾都会有^M的标记,看起来很不舒服。

“文件的编码格式要求为UTF-8”,这个是因为Android源代码工程以及GIT工具都使用UTF-8的字符集,如果如果用非UTF-8编码写的中文注释,那么在代码编译以及GIT网页上查看,都会显示为乱码,让人无法了解修改代码的目的与原因,会造成后续问题跟踪的沟通成本。如果这段代码再被cherry-pick到新分支,代码编译的时候还会一直Warning你的名字,那么恭喜你,你已经万众皆知了,当然是不好的方面。

 

 

 

 

Intellij IDEA设置

首先找到Android工程中的development/ide/intellij/codestyles目录下的AndroidStyle.xml文件,该文件为谷歌预定义的一些Android基本的代码样式,将其拷贝到C://用户/sunyaxi/.IdealIC12/config/codestyles目录下。其次,打开IDEA进入设置界面,在CodeStyle选项中选择AndroidStyle这个样式,此样式即满足TAB键转为4个空格的要求。如图所示:

 

 

 

使用谷歌预定义的代码格式,该格式满足TAB用四个空格代替的要求。

 

 

 

 

设置Unix文件格式,这里需要选择Unix and OS X (\n)这项。

 

 

设置文件编码格式,将这里的字符集都修改为UTF-8。

 

 

 

 

显示空格字符,可以防止不经意间从别的地方引入TAB字符,保持代码整洁。

 

 

Notepad++设置

    

在“设置->首选项”中,在“新建”菜单项可以设置文件格式为Unix格式,并设置字符集为UTF-8。

 

 

在“选项卡设置”菜单中,将“选项卡大小”设置为4,并勾选“使用空格替换”。

 

 

 

 

 

 

Vim配置

使用root权限到/etc/vim目录下新建vimrc.local文件,在该文件中输入以下内容并保存即可。

set number

set tabstop=4

set shiftwidth=4

set smarttab

set expandtab

 

 

 

 

 

 

 

 

 

 

 

 

Eclipse配置

在Android项目代码中的development/ide/eclipse文件夹下,有如下文件:

 

我们需要的是android-formatting.xmlandroid-symbols.xml这两个文件。

 

从Eclipse的菜单栏“window->preferences”进入设置界面,在“Java->Code Style->Formatter”的菜单中,选择导入刚才的Android-formatting.xml这个文件,导入完成之后选择Android作为默认代码格式。这个代码样式满足Tab键为4个空格的要求。

 

 

 

 

 

 

    进入“General->WorkSpace”,按照下面所示内容,将默认字符集修改为UTF-8,并将文件格式默认为Unix格式。

 

    进入“General->Editors->Text Editors”菜单项中,将“Show whitespace characters”勾选,点开“configure visibility”,将“Carriage Return”以及“Line Feed”这两个去除勾选。

 

 

 

 

 

 

 

 

Source Insight配置

Source Insight这款工具看源代码是利器,但是该工具有个特别不好的地方,那就是它不支持Unicode字符集,所以UTF-8编码文件中的中文在Source Insight下查看都是乱码,如果选择“Visible tabs”或“Visible spaces”,那么这些字符也显示为乱码。所以这款工具推荐只用来看代码,而不要进行修改或提交代码。可能你自己使用起来很方便,但是提交上去的代码可能格式惨不忍睹,给代码维护带来风险。

 

下面说下C代码中,怎么设置TAB键为4个空格符。在菜单栏中“Options->Document options”,在“Document Type”中选择会用到文件类型,这里以C文件为例,按照下图将TAB键转换为4个空格。

 

 

 

 

 

 

 

Beyond Compare配置

 

    在Beyond Compare的菜单栏中“Tools->File formats”,将“C,C++,C# Source”、“Java Source”、“XML”以及默认的“Text Format”中的TAB键替换为4个空格,勾选“Inert spaces instead of tabs”, 并把“Tab stops”大小调整为4,如下所示:

 

 

 

 

 

转载于:https://www.cnblogs.com/kevincode/p/3823848.html

转载地址:https://blog.csdn.net/weixin_30807779/article/details/98247154 如侵犯您的版权,请留言回复原文章的地址,我们会给您删除此文章,给您带来不便请您谅解!

上一篇:【Leetcode】【Easy】Symmetric Tree
下一篇:第三篇:Logstash 安装配置

发表评论

最新留言

路过按个爪印,很不错,赞一个!
[***.219.124.196]2024年04月15日 17时44分48秒