Contents:
- 1 개요
- 2 관련서적
- 3 주요링크
- 4 Naming 기법 1
- 5 Naming 기법 2
- 6 Naming 기법의 예
- 7 Naming 기법에 대한 답글
- 7.1 1002 님의 답글
- 7.2 didarenas 님의 답글
- 7.3 didarenas 님의 답글
- 8 다운로드
- 9 관련링크
Naming 기법 이란 개념이나 용어는 이전에 따로 소개된 적이 없다. 왜냐면 내가 그냥 주먹구구식으로 만들어서 쓰고 있는 방식이기 때문이다.
비슷한 걸 찾아 보자면 리팩토링의 Rename 이란 것이 있는데 Rename 이란 것은 기능에 맞도록 변수나 메소드의 이름을 잘 달자라는 개념이기 때문에 여기서 얘기할 Naming 기법과는 좀 다르다고 할 수 있다. 하지만 사실 여기서 얘기할 Naming 기법도 Rename 에서 영감과 힌트를 얻어 만들었다고 할 수 있다.
이것을 만들 게 된 과정은 일단 Rename 기법의 강력함을 깨닫게 되면서부터였다. 해당 로직을 Extract 하고 Name 을 지으며 소스 코드가 정리되는 것을 보면서 정말 뭔가 맥을 짚을 수 있는 느낌이 들면서부터 한가지 문제에 봉착하게 되었다.
그 문제란 무엇이냐 하면 변수나 메소드의 이름을 결정할 때 어떠한 기준으로 어떠한 방법을 통해 결정할 것이냐 하는 것이다. 물론 사전을 찾아가며 고심하며 이름을 지어야 함은 당연한 것이다. 하지만 단어의 조합만으로 변수나 메소드의 이름을 짓는다면 조합의 수가 너무 많아진다. 그러므로 단순히 그것 말고 좀 더 일관된 Naming 방법이 필요함이 느껴졌다.
결과적으로 얘기하자면 Naming 에는 일단 다음과 같은 중요한 방법적 요결이 쓰인다.
- 몇가지 접두사와 접미사 전치사등을 정의해둔다.
- 기능을 의미하는 영단어를 고른다.
- 접두사와 접미사 전치사등을 위에서 고른 영단어와 조합한다.
이런 식으로 작성하면 통일되고 일관된 소스 코드를 얻을 수 있다. ( 물론 내 기준이다. 고수님들이 보시면 웃기다고 욕하실지도 모른다 )
이 Naming 방법의 장점을 들라면 리팩토링이 용이한 소스코드가 될 수 있다는 것이다.
C++ 로 작성함에 있어 리팩토링 툴이 절대적으로 부족함을 알 수 있다. C++ 소스코드가 완전히 개체 지향적이라고 할 수 없기 때문에 그러한 툴이 부족하리라 추측된다.
그런 이유로 주로 수동으로 리팩토링 작업을 하게 되는데 만약 소스코드에 위에서 얘기한 Naming 방법이 적용되어 있다면 IDE 에서 제공하는 단순한 찾기 기능만으로도 아주 효과적으로 리팩토링 작업을 수행할 수 있다.
(해당 접두사나 접미사와 영단어가 조합되는 방식이 항상 일관되기 때문에 어디에서 무엇을 찾아야 할지 그 범위를 우선 결정하기 쉬워진다)
각각의 용어선택이나 실제 네이밍은 개인마다 달라지겠지만 나의 경우는 아래와 같은 접두사와 접미사 전치사등을 주로 쓴다.
| 단 어 | 설 명 |
| Create~ | 클래스의 필드를 설정하거나 리소스등을 로드한다. 초기화가 아니다. ( NULL 값이나 0 으로의 초기화는 생성자에서 하는 것이 가장 낫다고 생각된다. 또 개인적으로 생성자에서 데이터를 설정하거나 리소스등을 로드하는 것은 클래스의 구조가 다분히 복잡해질 가능성이 농후하므로 별로 좋아하지 않는다. |
| Update~ | 클래스의 작동, 즉 계속해서 데이터를 갱신하는 루틴이 들어간다. |
| Display~ | 화면에 출력되는 루틴 |
| Destroy~ | 클래스의 필드를 초기화하고 리소스등을 해지한다. |
| Make~ | 어떤 값을 계산한다. |
| Select~ | 어떤 값을 선택한다. |
| ~For~ | 무엇을 위한 |
| ~To~ | 어디로 아웃풋 |
| ~From~ | 어디에서 인풋 |
| ~With~ | 무엇을 가지고 |
위에 것들이 주로 내가 고유하게 쓰는 것들이고 그 외에는 관용적인 방식을 따른다. 즉, Get~, Set~ 계열의 메소드나 Add~ 뭐 이런 것 말이다.
자작한 클래스의 헤더파일을 보이겠다. 위의 사항이 어떻게 적용되는지 알 수 있을 것이다.
1 // MainMenu.h: interface for the CMainMenu class.
2 //
3 //////////////////////////////////////////////////////////////////////
4
5 #if !defined(AFX_MAINMENU_H__59E43BBD_795D_4FCC_B963_071F9DF15BB8__INCLUDED_)
6 #define AFX_MAINMENU_H__59E43BBD_795D_4FCC_B963_071F9DF15BB8__INCLUDED_
7
8 #if _MSC_VER > 1000
9 #pragma once
10 #endif // _MSC_VER > 1000
11
12 #include "Process.h"
13
14 #include "ButtonBox.h"
15 #include "DlgBox.h"
16
17
18 class CCreatureInWorld;
19
20
21 class CMainMenu : public CProcess
22 {
23 public:
24 CCreatureInWorld *m_CIW;
25
26 public:
27 HWND m_Hwnd;
28
29 public:
30 CBox MainMenuImage;
31
32 CButtonBox MainMenuButtonCookingWorld;
33 CButtonBox MainMenuButtonBeautyWorld;
34 CButtonBox MainMenuButtonLoadGame;
35 CButtonBox MainMenuButtonViewOpening;
36 CButtonBox MainMenuButtonExitGame;
37
38 //대화 상자
39 CBox MainMenuExitDlgImage;
40 CBox MainMenuLoadDlgImage;
41
42 CButtonBox MainMenuDlgButtonOk;
43 CButtonBox MainMenuDlgButtonCancel;
44
45 BOOL bExitDlg;
46 BOOL bLoadDlg;
47
48 public:
49 void Create();
50 void Update();
51 void Display();
52 void Destroy();
53
54 public:
55 CMainMenu(HWND hwnd,CPowerDC *pPowerDC,CInPutManager *pInputMgr,
56 CResourceMgr *pResourceMgr,CCreatureInWorld *pCIW);
57 virtual ~CMainMenu();
58
59 };
60
61 #endif // !defined(AFX_MAINMENU_H__59E43BBD_795D_4FCC_B963_071F9DF15BB8__INCLUDED_)
1 // PlayGame.h: interface for the CPlayGame class.
2 //
3 //////////////////////////////////////////////////////////////////////
4
5 #if !defined(AFX_PLAYGAME_H__D7FA1D59_4BE4_4336_AD4A_F0AF9ABDB5D8__INCLUDED_)
6 #define AFX_PLAYGAME_H__D7FA1D59_4BE4_4336_AD4A_F0AF9ABDB5D8__INCLUDED_
7
8 #if _MSC_VER > 1000
9 #pragma once
10 #endif // _MSC_VER > 1000
11
12 // #pragma warning(disable:4786)
13
14 #include "Process.h"
15
16 #include "Defines.h"
17 #include "DataClass.h"
18
19 #include "Creature.h"
20
21 #include "CreatureInWorld.h"
22
23 #include "DlgBox.h"
24 #include "ButtonBox.h"
25
26 #include "Grid.h"
27 #include "StageSetupMgr.h"
28
29 #include "FootPrintEffectMgr.h"
30
31 #include <vector>
32 #include <map>
33
34 using namespace std;
35
36 class CMap;
37
38
39 #include "EffectMgr.h"
40 #include "ActorWeaponMgr.h"
41
42 #include "ParticleMgr.h"
43
44 #include "GeneralWeapon.h"
45 #include "SpecialWeapon.h"
46
47 #include "GateMgr.h"
48
49
50 class CPlayGame : public CProcess
51 {
52 public:
53 CGateMgr GateMgr;
54
55 // 보스 전을 위하여
56 //======================================
57 public:
58 CCreature GreateActor;
59 CCreature GreateTrans;
60
61 public:
62 void MoveGreateActor();
63 void MoveBoss(CCreature *pBoss);
64
65 void CreateGreateActor();
66 void UpdateGreateActor();
67 void DestroyGreateActor();
68
69 void UpdateBoss();
70
71 public:
72 CGeneralWeapon BossGeneralWeapon;
73 CSpecialWeapon BossSpecialWeapon;
74
75 public:
76 void CreateBossWeapon();
77 void UpdateBossWeapon();
78 void DisplayBossWeapon();
79 void DestroyBossWeapon();
80
81 //======================================
82 public:
83 CFootPrintEffectMgr FootPrintEffectMgr;
84
85 public:
86 CStageSetupMgr StageSetupMgr;
87
88 public:
89 CParticleMgr MagicEffectMgr;
90 CParticleMgr DropEffectMgr[5];
91
92 CAniBox MagicEffect;
93 CAniBox DropEffect;
94
95 public:
96 void MakeActor(int x,int y,SPR *pSpr,int uiUniqueID);
97 void MakeObject(int x,int y,SPR *pSpr,int uiUniqueID);
98 void MakeCharAndEnemy(int x,int y,SPR *pSpr,int uiUniqueID);
99
100 public:
101 CEffectMgr EffectMgr;
102
103 public:
104 // 단어 출력 연출 관련
105 CTimeUtil WordEffectTimer;
106
107 BOOL bWordEffectPause;
108
109 public:
110 CActorWeaponMgr ActorWeaponMgr;
111
112 public:
113 void CommandDisplayWord();
114 void CommandStageClear();
115 void CommandGameOver();
116
117 void MoveActor();
118 void MoveEnemy(CCreature *pEnemy);
119 void MoveCharacter(CCreature *pCharacter);
120
121 public:
122 void MakeEnemyWeapon(CCreature *pCreature,int y,int x);
123
124 public:
125 // 적 보스 무기 관련
126 CCreature CookingBossWeapon;
127 CCreature BeautyBossWeapon;
128
129 public:
130 // 무기 관련
131 int iUniqueWeaponIDCount; // 적군 무기들에 id를 부여하기 위한 임시 id저장 변수
132
133 void StartFireWeapon(CCreature *pWeapon,CCreature *pCreature);
134 void UpdateWeapon(CCreature *pWeapon);
135
136 void CreateEnemyWeapon(CCreature *pEnemy);
137 void UpdateEnemyWeapon(CCreature *pEnemy);
138
139 public:
140 // 시스템 대화상자 구성
141 CDlgBox SystemDlg;
142
143 BOOL bSystemDlgPause;
144
145 // 데이터
146 public:
147 CGrid Grid;
148 CCreatureInWorld *m_CIW;
149
150 CDisplayList DisplayList;
151
152 public:
153 CMap *m_pMap;
154 CDataClass *m_pDataClass;
155
156 // 데이터 갱신 메소드
157 public:
158 void PopUpSystemDlg();
159
160 void UpdateSystemDlg();
161 void UpdateActor();
162 void UpdateEnemy();
163 void UpdateCharacter();
164
165 void UpdateCheckCollision();
166
167 void UpdateInterface();
168 void UpdateItemMgr();
169 void UpdateWordMgr();
170
171 void UpdateStageClear();
172 void UpdateGameOver();
173
174 // 출력 메소드
175 public:
176 void DisplayBackTile();
177
178 void DisplayCreatureList();
179 void DisplayInterface();
180
181 void DisplaySystemDlg();
182
183 void DisplayProfilingData();
184
185 public:
186 void DisplayWord();
187
188 // 도우미 메소드
189 public:
190 void MakeDisplayList();
191 BOOL CheckIDList(int id);
192
193 void InitCreatureInWorld(CCreatureInWorld *pCIW);
194 void EndCreatureInWorld();
195
196 void InitThisField();
197 void SearchSoundID();
198
199 public:
200 void LoadMap();
201 void UnLoadMap();
202
203 UI16 CreateUnit(UI16 uiUniqueID, SI16 x, SI16 y);
204 void SetStageClearData();
205
206 public:
207 void PlayBGM();
208 void StopBGM();
209
210 int iCurBossLife;
211
212 CBox CookingBossLifeGuage;
213 CBox BeautyBossLifeGuage;
214 CBox BossLifeBar;
215
216 void DisplayBossLifeGuage();
217
218 //기본 메소드
219 public:
220 void Create();
221 void Update();
222 void Display();
223 void Destroy();
224
225 public:
226 CPlayGame(CPowerDC *pPowerDC,CInPutManager *pInputMgr,
227 CResourceMgr *pResourceMgr,CCreatureInWorld *pCIW);
228 virtual ~CPlayGame();
229 };
230
231 #endif // !defined(AFX_PLAYGAME_H__D7FA1D59_4BE4_4336_AD4A_F0AF9ABDB5D8__INCLUDED_)
1 // StageClear.h: interface for the CStageClear class.
2 //
3 //////////////////////////////////////////////////////////////////////
4
5 #if !defined(AFX_STAGECLEAR_H__60D38299_D7CE_41AF_979C_A7E846E3EADF__INCLUDED_)
6 #define AFX_STAGECLEAR_H__60D38299_D7CE_41AF_979C_A7E846E3EADF__INCLUDED_
7
8 #if _MSC_VER > 1000
9 #pragma once
10 #endif // _MSC_VER > 1000
11
12 #include "Process.h"
13
14 #include "ButtonBox.h"
15 #include "TextMgr.h"
16
17 #include "CreatureInWorld.h"
18
19
20 class CStageClear : public CProcess
21 {
22 public:
23 int iPlusVal;
24
25 public:
26 CCreatureInWorld *m_CIW;
27
28 public:
29 CBox StageClearImage;
30 CButtonBox StageClearButtonNextStage;
31
32 // 다음 스프라이트들은 스테이지마다 달라진다.
33 // 블럭 이미지는 전반이냐 후반이냐에 따라
34 CBox BlockImage;
35
36 // 몬스터는 스테이지에 설정된 몬스터 타입에 따라
37 CBox MobImage[3];
38
39 // 단어는 스테이지에 설정된 단어에 따라
40 CButtonBox Word0Image;
41 CButtonBox Word1Image;
42 CButtonBox Word2Image;
43 CButtonBox Word3Image;
44
45 public:
46 void Create();
47 void Update();
48 void Display();
49 void Destroy();
50
51 public:
52 CStageClear(CPowerDC *pPowerDC,CInPutManager *pInputMgr,
53 CResourceMgr *pResourceMgr,CCreatureInWorld *pCIW);
54 virtual ~CStageClear();
55 };
56
57 #endif // !defined(AFX_STAGECLEAR_H__60D38299_D7CE_41AF_979C_A7E846E3EADF__INCLUDED_)
각각은 메인메뉴, 실제 게임 플레이, 스테이지 클리어 결과화면에 대한 클래스이다. 각 클래스는 모두 Create(), Update(), Display(), Destroy() 메소드를 가지고 있고 해당 클래스의 다른 메소드들은 거의 대부분 이 네 개의 메소드안에서 호출된다. 즉 외부에 공개된 메소드는 위 네 개뿐이다.( 모두 public 으로 선언한 것을 가지고 태클걸지 마세요. 제 취향입니다. 완전히 클래스 내부에서만 필요한 것이라고 판단되면 그때 고쳐도 늦지 않다고 생각하므로 그렇게 하고 있습니다. )
어떤식으로 호출되는지 잠깐 구현의 일부를 보자면 다음과 같다. 아마 보면 바로 이해가 가능할 것이다.
1 void CMainMenu::Display()
2 {
3 MainMenuImage.Display(m_pPowerDC,0,0);
4
5 //게임 종료 대화 상자 출력
6 if(bExitDlg==TRUE)
7 {
8 MainMenuExitDlgImage.Display(m_pPowerDC,142,193);
9
10 MainMenuDlgButtonOk.Display(m_pPowerDC,m_pInputMgr,182,320);
11 MainMenuDlgButtonCancel.Display(m_pPowerDC,m_pInputMgr,401,320);
12 }//게임 로드 대화 상자 출력
13 else if(bLoadDlg==TRUE)
14 {
15 MainMenuLoadDlgImage.Display(m_pPowerDC,142,193);
16
17 MainMenuDlgButtonOk.Display(m_pPowerDC,m_pInputMgr,182,320);
18 MainMenuDlgButtonCancel.Display(m_pPowerDC,m_pInputMgr,401,320);
19 }//메인 메뉴 출력
20 else
21 {
22 MainMenuButtonCookingWorld.Display(m_pPowerDC,m_pInputMgr,74,292);
23 MainMenuButtonBeautyWorld.Display(m_pPowerDC,m_pInputMgr,401,292);
24 MainMenuButtonLoadGame.Display(m_pPowerDC,m_pInputMgr,74,435);
25 MainMenuButtonViewOpening.Display(m_pPowerDC,m_pInputMgr,298,435);
26 MainMenuButtonExitGame.Display(m_pPowerDC,m_pInputMgr,507,435);
27 }
28 }
이 외에도 몇가지 작업을 효율적으로 하기 위해 쓰는 것들이 있는데 이는 다음에 또 써보겠다.
리팩토링책의 저자인 Martin Fowler, Kent Beck, 그리고 중간중간 아티클을 쓴 Ron Jeffries 의 코드들을 읽어보면 뭔가 그림이 그려지는 바가 있습니다. 하나는 OO 적인 사고방식이고 ( 그것도 Smalltalk 로 많이 프로그래밍을 해본, Class 가 아닌 Object 를 중심으로 하는 사고 ) 하나는 Programming By Intention ( 의도가 드러나는 프로그램 ) 입니다. 그리고 이에 대해 좋은 책중 하나가 Smalltalk Best Practice Patterns 라는 책인데, 코드는 Smalltalk 이지만 해당 내용들은 다른 언어에서도 적용해봄직한 좋은 가독성의 코드를 만드는데 도움을 주는것들이 많습니다.
그중 몇가지 패턴을 이야기한다면
- 해당 메소드 내에서 abstraction level 을 일정하게 유지하라. - rename 과 extract method 를 할때의 기준이 됩니다.
- 메소드 이름을 지을때는 'How' 보다 'What' 이 드러나게 하라. 그리고 대부분 메소드를 지을때는 동사가 먼저 나옵니다.영어권의 사람들에게는 자신들의 사고방식과 바로 매핑되어서일지도 모르겠습니다. 즉, 코드가 '해당객체.동사.(파라메터)' 식이 되죠.
그리고 위의 내용중 동의하는 바로는
- 생성자에서 데이터를 설정하거나 리소스등을 로드하지 않는다 - 가능한 한 생성자에서는 실패가능성이 높은 작업을 하지 않습니다.
그리고 코드상 동의하지 않는 점으로는 ( 예제로 서술하신건데 괜한 딴지인 것도 같습니다만 ^^; 한편으로 작성하신 주제와도 맞지 않긴 합니다. ) CCreature 을 해당 메소드의 인자로 넘기시는것이 많습니다. 이 경우 해당 메소드가 CCreature 에 있어야 할 것이 아닌가 생각해보심이 좋을 듯 합니다. ( 혹은, CCreature 클래스의 서브클래스로 CEnemy, CWeapon 등이 더 있어야 할지도요 ) 클래스의 갯수는 많아지지만, 디자인 상으로 는 좀 더 단순해질겁니다.
ps. C++ 이 리팩토링 툴을 만들기 어려운건 아마도 C 의 유산을 받아서인지도 모르겠습니다. 리팩토링 툴의 경우 AST 단에서의 처리를 하는것이 기본인데, 이놈의 매크로와 프리프로세서들은 자동 리팩토링처리를 하는데 난감한 상황을 만들어내니까요.
생성자에서 인자로 받는 것은 팩토리 패턴을 이용한 프로세스 생성 구조의 프레임 워크라서 그렀습니다. 물론 다른 메소드가 작성되어 있긴 한데 그냥 생성자 내부에서 호출하도록 했습니다. 아마 생성 시점에 생성 후 바로 호출해도 문제없으리라 봅니다. 그래픽 관리자, 인풋관리자, 리소스관리자를 싱글톤을 이용하지 않고 매개 변수형식으로 받았는데 순전히 제 취향이구요. 이 세가지 관리자를 하나의 클래스에 담아 그것을 넘기는게 더 깔끔할듯 생각됩니다. 물론 CCreatureInWorld 는 그런식으로 작성된 것이구요. 이 소스는 작년에 짠 것인데 이것저것 실험해보느라 같은 작업인데도 몇가지 다른 방식으로 해놨군요.
관심가져주셔서 감사드리구요. 말씀하신 스몰토크에 관한 책은 시간 나면 읽어봐야겠네요. 요즘은 다른 공부를 좀 하고 있어서리 대략 시간이 잘 안난다는...
.gif ":)")
아참 CCreatureInWorld 는 게임 월드를 구성하는 모든 데이터를 담고 있는 클래스입니다. 프로그램 전체를 통털어 게임 월드 구성 데이터에 접근 가능하도록 하려고 하니 이게 편하더군요.
![[http]](/wiki2/imgs/http.png)
