Qt/C/C++推荐代码规范

Qt/C/C++工程推荐使用下面代码规范:

  1. 代码采用C/C++11标准,尽量使用智能指针,尽量不使用裸指针(QT中可以使用QScopedPointer)
  2. 函数和变量命名使用骆驼式命令法,采用动宾语法,例如printEmployeePaychecks(). C++头文件用.hpp后缀, 源文件用.cpp后缀, C头文件用.h后缀, 源文件用.c后缀. 文件的命名使用全小写并下划线分割,如a_b_c.cpp
  3. 尽量使用Qt5新的信号和槽连接方式,信号和槽的命名不加signal和slot前缀,用动作和on动作方式,如信号clicked(),槽为onClicked().
  4. 关键代码需要有单元测试,非界面代码一般认为是关键代码
  5. 默认debug build前推荐使用静态代码检查工具(Cppcheck/Clang/VS)检查,编译时使用gcc sanitizer增加地址和未定义行为动态检查,
  6. 开启qtcreator插件beautifier中的代码格式化工具Clang-format, 风格选择文件, 请保存下面的Clang-Format 风格文件到.clang-format风格文件并放在代码根目录下.
  7. 代码注释方式采用Doxygen方式, 有需要的地方需要增加注释,注释采用中文。函数,类,结构声明都认为是有需要的地方, 注释放在要被注释的代码上一行,并单独一行,不提倡放在代码同一行末尾或下一行(除非是参数列表)。
  8. 在填入界面显示文字时,使用英文,通过Qt Linguist翻译成中文,便于以后多语言, 文件编码一律使用UTF-8,添加BOM
  9. 在绘制界面的时候,尽量使用layout和stretch来布局,尽量不要使用固定的大小,如固定10像素, 以便适应窗口大小变化. 
    
  10. 不能直接提交代码,需要创建合并请求,并把合入请求分配给另一个同事,其他同事如果发现有问题,填写评论后给回提出合入请求的同事。问题都解决后分配给有合入权限的同事。
  11. 最终提交的代码必须通过服务器的编译, 并且执行测试没有发现错误和警告.
  12. 未说明的风格请参考Qt风格, https://wiki.qt.io/Coding_Conventions, https://wiki.qt.io/Qt_Coding_Style
  13. 版本的命名方式遵循[语义化版本 2.0.0](http://semver.org/lang/zh-CN/)
    

Clang-Format 风格文件

# Copyright (C) 2016 Olivier Goffart <ogoffart@woboq.com>
#
# You may use this file under the terms of the 3-clause BSD license.
# See the file LICENSE from this package for details.

# This is the clang-format configuration style to be used by Qt,
# based on the rules from https://wiki.qt.io/Qt_Coding_Style and
# https://wiki.qt.io/Coding_Conventions

---
# Webkit style was loosely based on the Qt style
BasedOnStyle: WebKit

Standard: Cpp11
ColumnLimit: 100

# Disable reflow of qdoc comments: indentation rules are different.
# Translation comments are also excluded
CommentPragmas: "^!|^:|^=|^~"

# We want a space between the type and the star for pointer types
PointerBindsToType: false

# We want to break before the operators, but not before a '='
BreakBeforeBinaryOperators: NonAssignment

# Braces are usually attached, but not after functions or classes declaration
BreakBeforeBraces: Custom
BraceWrapping:
    AfterClass: true
    AfterControlStatement: false
    AfterEnum: false
    AfterFunction: true
    AfterNamespace: false
    AfterObjCDeclaration: false
    AfterStruct: true
    AfterUnion: false
    BeforeCatch: false
    BeforeElse: false
    IndentBraces: false

# The coding style does not specify the following, but this is what gives
# results closest to the existing code.
AlignAfterOpenBracket: true
AlwaysBreakTemplateDeclarations: true

# Ideally we should also allow less short function in a single line, but
# clang-format does not handle that
AllowShortFunctionsOnASingleLine: Inline

# The coding style specifies some include order categories, but also tells to
# separate categories with an empty line. It does not specify the order within
# the categories. Since the SortInclude feature of clang-format does not
# re-order includes separated by empty lines, the feature is not used.
SortIncludes: false

# Extra
AlignTrailingComments: true

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,711评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,932评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,770评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,799评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,697评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,069评论 1 276
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,535评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,200评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,353评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,290评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,331评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,020评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,610评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,694评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,927评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,330评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,904评论 2 341

推荐阅读更多精彩内容