김성민/CodingGuideline

UserPreferences

1. 개요
2. Naming Guidelines
1. Capitalization Rules for Identifiers
2. Capitalzing Acronyms
3. Capitalizing Compound Words and Common Terms
3. Visual Basic Hungarian Notation

1 개요

표준 같은 건 아니고, 개인적으로 사용하는 코드 작성 가이드라인. 여기저기서 본 것들 중에서 괜찮다고 생각하는 것들을 정리해둔다.

2 Naming Guidelines

2.1 Capitalization Rules for Identifiers

• 네임스페이스, 타입, 함수 이름, 멤버 변수는 파스칼 케이싱
  
• 함수 인자는 카멜 카이싱
  
• 지역 변수는?
  
  

2.2 Capitalzing Acronyms

• 2글자짜리 줄임말은 둘 다 대문자/소문자로 쓴다.
  

  public void StartIO(Stream ioStream, bool closeIOStream) 
  

• 3글자 이상의 줄임말은 첫글자만 대문자로 쓴다.
  

  public void ProcessHtmlTag(string htmlTag) 
  

• Id, Ok 는 예외
  
  

2.3 Capitalizing Compound Words and Common Terms

compound word 에는 3가지 종류가 있다.


• closed form : firefly, secondhand, softball, childlike, crosstown, redhead, keyboard, makeup, notebook
  
• hyphenated form : daughter-in-law, master-at-arms, over-the-counter, six-pack, six-year-old, mass-produced
  
• open form : post office, real estate, middle class, full moon, half sister, attorney general
  
  
closed form 인 경우, 하나의 단어로서 취급한다. 즉 중간에 대문자를 섞어쓰지 않는다. 사전을 찾아서 하도록 하자.



Pascal	Camel	Not
BitFlag	bitFlag	Bitflag
Callback	callback	CallBack
Canceled	canceled	Cancelled
DoNot	doNot	Dont
Email	email	EMail
Endpoint	endpoint	EndPoint
FileName	fileName	Filename
Gridline	gridline	GridLine
Hashtable	hashtable	HashTable
Id	id	ID
Indexes	indexes	Indices
LogOff	logOff	LogOut
LogOn	logOn	LogIn
Metadata	metadata	MetaData, metaData
Multipanel	multipanel	MultiPanel
Multiview	multiview	MultiView
Namespace	namespace	NameSpace
Ok	ok	OK
Pi	pi	PI
Placeholder	placeholder	PlaceHolder
SignIn	signIn	SignOn
SignOut	signOut	SignOff
UserName	userName	Username
WhiteSpace	whiteSpace	Whitespace
Writable	writable	Writeable
Shutdown	shutdown	ShutDown
Childs	childs	Children, children


뭔가 좀 미묘한데...

3 Visual Basic Hungarian Notation

Type	Prefix	Desc
Empty
Null
Boolean	bln, b
Byte	byt
Integer	int, n	-32768 ~ 32767
Currency	cur
Long	lng, n	-2147483648 ~ 2147483647
Single	sng, f
Double	dbl, f
Date(Time)	dtm
String	str
Object	obj
Error	err
Array	arr
Collection	col


Object Hungarian Notation Naming Conventions for VB