1. 네이밍 률
|
이 문서 전반에 걸쳐 파스칼표기법과 카멜 표기법이 사용된다. 파스칼 표기법 - 모든 단어에서 첫번째 문자가 대문자이며 나머지는 소문자이다. 예: BackColor 카멜 표기법 - 최초에 사용된 단어를 제외한 첫번째 문자가 대문자이며 나머지는 소문자이다. 예: backColor |
1. 클래스 명에는 파스칼 표기법을 사용한다.
ICP 적용 예 :
public class ConnRS232
2. 함수(Method) 명에는 파스칼 표기법을 사용한다.
void OpenRS232(string name)
3. 변수와 함수 파라미터에는 카멜표기법을 사용한다.
string addressData = string.empty
void SayHello(string name)
4. 변수는 풀네임으로 의미를 명확히 한다
ex) addr -> address
txt -> text
5. 루프에서 반복을 의미하는 변수만 I, j, k를 사용한다
ex) for ( int i = 0; i <count; i++ )
6. 지역변수에는 밑줄(_)을 사용하지 않는다.
7. 모든 멤버 변수들은 앞에 밑줄(_)을 사용해야 한다. 그래야 다른 지역변수들과 구분할 수 있다.
8. 키워드와 비슷한 이름을 사용하지 않는다
9. boolean 이 들어가는 변수, 속성, 함수(method)등은 "is" 또는 유사한 접두사를 사용한다.
예: private bool _isFinished
10. 닷넷에서 사용되는 컨트롤의 표준 네임 정의
|
Control |
prifix |
Control |
prifix |
|
Label |
lbl |
Checkbox |
chk |
|
TextBox |
txt |
CheckBoxList |
cbl |
|
DataGrid |
dtg |
RadioButton |
rdo |
|
Button |
btn |
RadioButtonList |
rbl |
|
ImageButton |
imb |
Image |
img |
|
Hyperlink |
hlk |
Panel |
pnl |
|
DropDownList |
ddl |
PlaceHolder |
phd |
|
ListBox |
lst |
Table |
tbl |
|
DataList |
dtl |
Validators |
val |
|
Repeater |
rep |
|
|
11. 파일명은 클래스 명과 같아야 한다.(파일명 또한 파스칼 명명법 적용)
ex)클래스명이 RS232면 파일명은 RS232.cs
2. 들여쓰기
1. 들여쓰기에는 TAB 을 사용한다. SPACE를 사용하지 않는다. Tab 사이즈는 4로 정의한다.
2. 주선은 코드와 같은 레벨에 있어야 한다(들여쓰기의 레벨을 같이 사용한다.).
3. 중괄호는 중괄호 밖에 있는 코드와 같은 레벨에 있어야 한다.
4. 중괄호는 다른 라인과 분리되어 있어야하며 라인을 같이 쓰면 안된다.
5. 지시자(operator)와 괄호 앞뒤로는 한 칸의 공간을 남긴다.
좋은 예:
if ( showResult == true )
{
for ( int i = 0; i <10; i++ )
{
//
}
}
6. 연관된 코드를 묶을때는 #region을 사용해라. #region을 사용해서 묶는다면 그 페이지는 훨씬 간략해질 것이다.
아직 미완성 률 이지만 예전에는 이렇게 썼다고 한다. 좀더 보강해서 완벽한 률을 만들어 한눈에 보기 싶게 유지보수가 최대한 잘될수 있도록 정하여 개발의 착수하였으면 좋겠다.