代码规范笔记

by luoshi006

代码风格

• Google 开源项目风格指南
• Qt Code Style
• Linux kernel coding style

提交策略

• Qt commit policy
• WebKit commit and review policy

注释

1. TODO

   'TODO' is for useful features, optimizations or 
   	refactorings that might be worth doing in the future.
   

2. FIXME

   'FIXME' is for things which are definitely broken, 
   	but where you want to not worry about it for the moment.
   

3. XXX

   'XXX' is for things that require more thought and 
   	that are arguably broken.
   

4. aka

   Also Known As
   

5. WIP

   WIP — work in progress
   

Tools

A Style

> sudo apt install astyle

# sigle file
astyle one.cpp

# folder
astyle --recursive ./*.cpp *.h *.cc *.hpp *.c

.astylerc

# For full docs:
# http://astyle.sourceforge.net/astyle.html
#

--style=1tbs
--suffix=none
--recursive

#缩进4个空格
--indent=spaces=4

--max-code-length=128
--pad-header
--unpad-paren
--suffix=none
--align-pointer=name
--align-reference=name
--lineend=linux

#TAB转换为空格
--convert-tabs
--verbose

#移除括号两端多余空格
--unpad-paren

--indent-switches
--indent-col1-comments

--mode=c

# disable the format
# // *INDENT-OFF*
# #define FOO_DECLARE_int32_(name) \
#         FOO_API_ extern ::Int32 FOO_FLAG(name)
# // *INDENT-ON*