안녕하세요 납땜능력자 입니다.
오늘은 지난번에 이어서 함수, 파일명 그리고 변수 작명하는 방법을 말씀드리겠습니다.
오늘 포스팅드리는 모든 내용은 제가 사용하는 코딩룰을 설명 드리는 것으로, 참고만 하여주시면 감사하겠습니다.
모든 작명은 "_"를 사용해 구분을 지어주고,CamelCase를 사용해 띄어쓰기를 해줍니다. CamelCases는 모든 단어의 시작은 대문자를 사용하여 각 단어들을 구분해 주는 방식입니다.
1. 파일명
파일명은 이전 포스팅에 잠깐 언급드린 방법과 같습니다. 파일명은 이전 포스팅에 적어두었던 파일명을 가지고 설명드리겠습니다.
파일명은 위처럼 작성합니다. 프로젝트명, 언더바, 함수 대재목, 파일 형식 순으로 작성합니다.
위처럼 파일명을 작성하는 이유는 프로젝트 폴더를 열어보았을 때 한눈에 이 프로젝트가 어떤 프로젝트인지 알 수 있고, 파일을 보았을때 이 파일 안에 어떤 내용의 코드들이 들어있는지를 파악하기 용이합니다.
- 프로젝트명 : 프로젝트 이름을 명시
- 띄어쓰기 : 프로젝트 아래 소 분류를 표시하기 위해 사용
- 함수 대재목 : 해당 파일 안에 어떤 코드가 들어있는지 확인하기 위한 대재목
- 파일 형식 : 파일 형식
2. 함수명
함수명은 아래와 같은 방식으로 작성합니다.
파일 명, 띄어쓰기, 함수 소재목 순서로 함수를 작성하고, 가장 중요한 것은 짧고 간결하게 가 가장 포인트입니다.
위 사진에서 "함수 소재목"을 보면 "ArduinoInit"이라고 작성해 두었습니다. 이를 풀어서 쓰면 "Arduinio Initialize"입니다. 함수명을 보고 유추가 되듯 아두이노 기본 설정을 담당하는 함수입니다. 굳이 "Initialize"를 "Init"이라고 줄여놓은 이유는 한눈에 보기 편하게 하기 위해서입니다. 함수명이 길어질수록 안 그래도 복잡하고 너저분해 보이는 코드인데 저의 경우에는 더더욱 눈에 띄지 않아서 위와 같이줄임말을 사용하게 됩니다.
- 파일명 : 파일 이름을 명시
- 띄어쓰기 : 프로젝트 아래 함수 소재목을 표시하기 위해 사용
- 함수 소재목 : 함수의 이름
3. 변수명
변수명은 위 함수명보다 더욱 짧고 심플하게 작성하고, 특히 변수 이름에 이 변수가 어떤 자료형을 사용하고, 입력받은 변수인지, 선언된 변수인지를 알 수 있도록 작성해 줍니다.
변수의 종류 자료형을 소문자로 표현해 주고, 이어서 변수 이름을 작성해 줍니다. 변수 이름은 함수명 보다 더 짧고 간결하게 작성해 줍니다. "ArduIP"를 풀어서 작성하면 "Arduino IP Address"입니다. 이 줄임말도 마찬가지로 변수명만 보고 무슨 변수인지 확인할 수 있도록 하기 위함입니다.
위에 이름을 "변수"라고 작성했는데, 사실 변수가 아니라 C# Winform의 컴포넌트 중 하나인 "TextBox"입니다. 변수명이라고 소개해 드렸지만, 함수 내에서 사용되는 변수를 포함한 모든 컴포넌트는 위 규칙을 따릅니다. TextBox는 줄여서 "tb", ComboBox는 줄여서 "cb" 등 컴포넌트는 2글자로 주로 사용하고, 변수 Integer는 "i", String은 "s", Byte는"b"라고 사용합니다.
좀 더 자세히 앞에 2글자를 설명드리겠습니다.
- 컴포넌트 : tb(TextBox), cb(ComboBox), rb(RadioBox) 등 2글자를 사용
- 변수 : Integer(i), String(s) 등 앞의 첫 글자를 따서 사용하고, 배열의 경우 Integer Array(ia), Byte Array(ba)와 같이 접미어를 사용하여 배열(a)인지, 포인터(p)인지 등을 구분합니다.
- 지역, 전역, 입력 : 지역변수로 선언된 경우 위 사진과 같이 변수 종류 + 변수 이름으로 표시하며, 전역변수 혹은 입력받는 변수의 경우 변수 종류 + "_" + 변수 이름을 사용해 중간에 "_"를 사용하여 구분해 줍니다.
아래는 변수명을 설정한 예시 코드를 보여드립니다.
public void BoardSetting_ArduinoInit(int i_Mode, ref Utill c_Utill)
{
byte[] baSendData = new byte[2];
baSendData[0] = i_Mode;
switch(i_Mode)
{
case (int)Index.Mode.MASTER :
baSendData[1] = ARDU.MASTERMODE;
break;
case (int)Index.Mode.Slave :
baSendData[1] = ARDU.SLEAVEMODE;
break;
}
c_Utill.PrintDebug("Init OK");
}
변수명에 사용되는 이 작명 중 앞에 소문자는 모든 컴포넌트 및 자료형이 대부분 지정이 되어있습니다. 위에는 몇 가지 경우만 적어 드렸지만, 나머지 작명규칙은 추후 C#코드를 소개하면서 소개해 드리도록 하겠습니다.
혹시 자세한 변수작명 방법이 필요하시면. 댓글에 이메일 남겨주시면 지금까지 사용된 작명이 정리된 파일을 공유드리겠습니다.
이상으로 C#에 사용될 모든 코딩룰을 간단하게 설명드렸습니다. 이후 모든 C#포스팅은 지금까지 설명드린 코딩룰을 따라 작성할 예정이며, 코드를 읽으실 때 참고하여 주시면 좀 더 가독성이 좋아지지 않을까 생각이 됩니다.
이후 다음 포스팅은 가장 기본 컴포넌트들을 설명드리고, 각 컴포넌트들을 다루는 방법을 소개해 드리겠습니다.
감사합니다.