编程规范之缩写(转)

来源:互联网 发布:社会学 知乎 编辑:程序博客网 时间:2024/05/17 04:30

很多编程规范里都提到了尽量避免使用缩写,理由是长度不是问题,确实对于编译器来说也许长度不是问题,但对于程序员来说,长度绝对是个问题。试问:Application_ShowDetails_Button APL_ShowDetails_BTN 你更喜欢写哪个?或者你还会在程序里写出URL的全称啊?

所以我们不应该避免使用缩写,而是应该避免乱用缩写,合理使用缩写。

通常我们推荐使用3个字符的缩写,如APLAVG等,形成缩写通用方法:
1
、去掉所有的不在词头的元音字母,并选取三个拼音单元的辅音字母。如screen写成srn
2
、使用每个单词的头一个或几个字母。
较短的单词可通过 1 形成缩写,较长的单词则通过 2 形成缩写。

组合单词使用如下规则:
3
、使用变量名中每个有典型意义的单词。如Countof Failure写成FailCnt
4
、去掉无用的单词后缀 ing, ed等。如Paging Request写成PagReq

另外尽量采用大家公认的缩写形式。

====== 常用缩写 ======

完整单词 缩写

A

average ——> avg

B

back ——> bk
background ——> bg
break ——> brk
buffer ——> buf

C

color ——> cr(clr)
control ——> ctrl

D

data ——> dat
delete ——> del
document ——> doc

E

edit ——> edt
error ——> err
escape ——> esc

F

flag ——> flg
form ——> frm

G

grid ——> grd

I

increment ——> inc
information ——> info
initial ——> init
insert ——> ins
image ——> img

L

label ——> lab
length ——> len
list ——> lst
library ——> lib

M

manager ——> mngr(mgr)
message ——> msg

O

Oracle——> Ora

P

panorama ——> pano
password ——> pwd
picture ——> pic
point ——> pt
position ——> pos
print ——> prn
program ——> prg

S

server ——> srv
source ——> src
statistic ——> stat
string ——> str
Sybase ——> Syb

T

temp ——> tmp
text ——> txt

U

user ——> usr

W

window ——> wnd(win)