E D R , A S I H C RSS

프로그램내�서�주�


주�� 없는 코드�서 그런지 해�하는 � 애먹었다

그렇다면 ìž�ì‹ ì�´ ê·¸ 코드를 í•´ì„�하면서 ì–»ì�€ ì§€ì‹�ì�„ ê·¸ 코드ì—� ì �용했ë�”ë�¼ë©´(좀 ë�” ì�˜ë¯¸ìžˆëŠ” 변수ì�´ë¦„, ë©”ì�¨ë“œì�´ë¦„ 사용, 코드 ì�¼ë€ë„ì�„ ì�˜ë¯¸ìžˆëŠ” ì�´ë¦„ì�˜ ë©”ì�¨ë“œë¡œ 추출 등) ì–´ë• ì�„까요? --JuNe
ì•„..Refactoring 하ë�¼ëŠ” ê±°êµ°ìš”.. 사실 설계 ìž�ì²´ì—�서ë�„ ë¹ ì§„ ìƒ�태ë�¼ ì „ì²´ 구조 ì�´í•´í•˜ëŠ”ë�° 가장 í�¬ê²Œ 애를 먹었습니다. 아무튼 ì§„ì§œ ì�´í•´í•œ 후ì—� 코드를 수정해 놓는 것ë�„ 좋ì�€ 방법ì�¸ê±´ ë„명하다고 ìƒ�ê°�합니다. ^^; --창섭

처ì�Œì—� Javadoc ì�„ 쓸까 하다가 계ì†� 주ì„�ì�´ 코드ì—� 아른 거려서 ë°©í•´ê°€ ë�˜ì—ˆë�˜ 관계로; (IntelliJ 3.0 ì�´í›„ë€í„´ Source Folding ì�´ ì§€ì›�하기 때문ì—� Javadocì�„ ë‹«ì�„ 수 있지만) 주ì„�ì�„ 안쓰고 프로그래ë°�ì�„ 한게 화근ì�¸ê°€ ë³´êµ°. 설계 시기를 따로 뺀 ì �ì�€ 없지만, Pair í•  때마다 매번 Class Diagram ì�„ 그리고 설명했ë�˜ 것으로 기억하는ë�°, 그래ë�„ 전체구조가 ì�´í•´ê°€ 가지 않았다면 ë‚´ 잘못ì�´ í�¬ì§€. 다ì�Œë€í„°ëŠ” ìƒ�민ì�´ì²˜ëŸ¼ 위키ì—� Class Diagram ì—…ë�°ì�´íЏë�œ 것 올리고, Javadoc 만들어서 generation 한 것 올리ë�„ë¡� 노력ì�„ 해야 ê² êµ°.

요새들어서 주ì„�ì�„ 잘 안쓰고 코드를 알아보기 쉽게 쓰려고 노력하긴 하는ë�°, ì•„ì§� 수련ì�´ ë€ì¡±í•´ì„œì�¸ì§€ 코드는 코드대로 어렵고 주ì„�ì�€ 주ì„�대로 없나 보다. í��í��;

약간 변명��면, 개�� 경험�서는 주�� 달린 코드는 주�� 시선� 먼저가고, 주�� 없는 코드�는 함수 프로토타입� 시선� 먼저간다�는 것. 하지만, ��가 전해지지 않았다면 역시 � 무�미한것�겠지. --�천

내가 가지는 주�� 관�� 지하철�서� 언급한 내용 거� 그대로지만, 내게 있어 주�� 주� 용�는 과거� �신과 대화를 하면서 집중� 유지, 진행� 체�하기 위해서 �고, 기타 �유는 �반�� �유� 타�� 대한 정보 전달�다. 전�는 command.Command.execute()�나 �규와 함께 달� information.InfoManager.writeXXX()위� 주�들�고,후�가 주로 쓰� 용�는 � class �단과 package 기술해 놓� 주��다. 그외� class diagram� �래 아나로그로 그린것� 있지만, 설명하면서 그린건 절대로 타�� 머리�� 통째로 저장� 남지 않는다는 전제로, (왜�면 내가 그러니까.) 타�� 열람� 위해 class diagram� 디지털화를 시켰다. 하는 김� 그런� 확실히 설명할때 JavaDoc뽑아서 그거가지고 설명하는게 편하긴 편하��. --�민

�바 IDE들� Source Folding � 지�하거나 comment 와 관련한 기능� 지�한다면 해결�듯. JavaDoc � API군�나 Framework Library� 경우 MSDN� 역할� 해주니까. --�천

ìž�네ì�˜ 경우는 주ì„�ì�´ ìž�네ì�˜ ìƒ�ê°�과정ì�´ê³ , ê·¸ 다ì�Œì�€ 코드를 ì�½ëŠ” 사람ì�˜ ê´€ì �ì�¸ ê±´ë�°, 프로그램ì�„ ì�´í•´í•˜ê¸° 위해서 ê·¸ 사람ì�€ ì–´ë–¤ 과정ì�„ 거칠까? 경험ì�´ 있는 사람ì�´ì•¼ 무엇ì�„ 해야 í•  ì§€ 아니까 abstract 한 í�´ëž˜ìФ ì�´ë¦„ì�´ë‚˜ 메소드들 ì�´ë¦„ë§Œ ë´�ë�„ 잘 ì�´í•´ë¥¼ 하지만, 나는 다른 사람들ì�´ 실제 코드 구현ë€ë„ë�„ ì�½ê¸°ë¥¼ 바랬거든. (소켓ì—�서 Read ë€ë„ 관련 블럭킹 방지를 위한 스레드ì�˜ ì�´ìš©ë°©ë²•ì�„ 모르고, Swing tree ì�´ìš©ë²• 모르는 사람ì—�ê²� ë�”ë�”ìš±. 해당 ë€ë„ì—� 대해선 Pair 중 설명ì�„ 하긴 했으니)

그리고 개��으론 Server 쪽 �해하기로는 Class Diagram � JavaDoc 보는것보다 � 편했�. 그거 본 다� 소스를 보는 방법으로 (완벽하게 �해하진 않았지만.). �건 내가 UML � � �숙해서가 아�까 함. 그리고 Java Source 가 비�� 깨�하기� �해하기 편하다는 �� 있겠고. (그래 소스 작성한 사람 칭찬해줄께;) --�천
좌절�다. �단 �네 �견� �� 정�가 아니� 같� ��� ��었다. 위� �네 �� 대한 내가 �미를 불확실하게 전달한거 같아서 세단� 정� 쓴거 같��.. 휴 �단 다시 짧게 줄��면, "프로그래머� 낙서� 표준"� UML과 ~cpp JavaDoc� 출발� 아예 다르다. �네가 바란건 디�� 단위로 프로그래�� �해하길 �한거 같��, 그것� ~cpp JavaDoc�서 �해주는건 불가능하다고 ��한다. Sun�서 msdn� 대�하기 위해(?) ~cpp JavaDoc� 태어난것 같�� ��다.

하지만, "확실히 설명할때 ~cpp JavaDoc뽑아서 그거가지고 설명하는게 편하긴 편하ë�”ë�¼."ë�¼ê³  한ë§� 풀어쓰는 ê±´ë�°, 만약 ë””ìž�ì�¸ ì�´í•´ 후ì—� 코드ì�˜ ì�´í•´ë�¼ë©´ ~cpp JavaDoc 없고 소스만으로 ì�´í•´ëŠ” 너무 어렵다.(최소한 나ì—�게는 그랬다.) ì�¼ë‹¨ 코드 ë„ì„�시 ~cpp JavaDocì�´ 나올 ì •ë�„ë�¼ë©´, "긴장 완화"ì�˜ 효과로 먹고 들어 간다. 그리고 우리가 코드를 ì�½ëŠ” 시ì �ì�€ jdk를 쓸때 ~cpp JavaDocì�„ ë³´ì§€ 소스를 보지는 않는 것처럼, 해당 메소드가 library처럼 ëŠ�껴지지 않ì�„까? 그것ì�´ 메소드ì�˜ ì�´ë¦„ì�´ë‚˜ 필드ì�˜ ì�´ë¦„만으로 완벽한 표현ì�€ 불가능하다고 ìƒ�ê°�한다. 완벽히 표현했다면 너무나 심한 세ë„화가 ì•„ë‹�까? ì „ì—� ì •ë§� 난해한 소스를 ë„ì„�한 ì �ì�´ 있다. 그때ë�„ ê°€ë�” ë³´ì�´ëŠ” 실낱같ì�€ 주ì„�들ì�´ 너무나 ë�„움ì�´ ë�œê²ƒì�´ 기억난다. 우리가 제출한 Report를 대학ì›� ìƒ�들ì�´ ë„ì„�할때 역시 마찬가지 ì�¼ê²ƒì�´ë‹¤. ì�´ê±´ ê¶�ê·¹ì�˜ Refactoring문제가 아니다. 프로그래ë°� 언어가 ê·¸ ì…°ì�µìŠ¤í”¼ì–´ 언어와 같았으면 하기ë�„ 하는 ìƒ�ê°�ì�„ 해본다. ìƒ�ê°�ì�˜ 언어를 프로그래ë°� 언어 대입할수만 있다면야.. --ìƒ�민

난해한 코드�수� 주�� 필요한 것�것�고 (�는 그 반대로 쉽게 알아볼 수 있�� 짤 방법� 강구해야 한다면 억지쓰는 것�려나.) 개��으로 �어본 가장 긴 낯선 코드가 3000~4000 ��� 못넘어 본 관계로 아�� '정리' 단계로만 �날 것 같다. CVS � history 가 코드 진화과정� 따�가는� �움� 줄것��고 ��했지만, 아�� 먼 �야기�듯.

ë‚´ê°€ Comment 와 JavaDoc 둘ì�„ 비슷한 대ìƒ�으로 ë‘�ê³  쓴게 잘못ì�¸ë“¯ 하다. ë‘�개는 좀 구ë„í•  필요가 있ì�„ 것 같다는 ìƒ�ê°�ì�´ 들어서다. ë‚´ë€ ì½”ë“œ 알고리즘 ì§„í–‰ì�„ 설명하기 위해서는 다는 주ì„�ì�„ comment로, 해당 구성 í�´ëž˜ìŠ¤ë“¤ì�˜ interface를 서술하는것ì�„ JavaDoc으로 구ë„하려나. ì�´ 경우ë�¼ë©´ JavaDoc ê³¼ Class Diagram ì�´ ê±°ì�˜ 비슷한 ì—­í• ì�„ 하겠지. (Class Diagram ì�´ 그냥 Conceptual Model ì •ë�„ë�¼ë©´ ë˜� ì�´ì•¼ê¸°ê°€ 달ë�¼ì§€ê² ì§€ë§Œ)

그리고, JDK 와 Application ì�˜ 소스는 ê·¸ 성격ì�´ 다르다고 ìƒ�ê°�해서. JDK ì�˜ 소스 ë„ì„�ì�´ëž€ JDKì�˜ í�´ëž˜ìŠ¤ë“¤ì�„ ì�½ê³  ê·¸ interface를 ì �ê·¹ì �으로 ì�´ìš©í•˜ê¸° 위해 하는 것ì�´ê¸°ì—� JavaDoc ì�˜ 위력ì�€ 절대ì �ì�´ë‹¤. 하지만, Application ì�˜ 소스 ë„ì„�ì�´ë�¼ 한다면 실질ì �ì�¸ implementation ì�„ 볼것ì�´ë�¼ ìƒ�ê°�하거든. ì–´ë–¤ 것ì�´ 'Information' ì�´ëƒ�ì—� 대해서 ë°”ë�¼ë³´ëŠ” ê´€ì �ì�˜ ì°¨ì�´ê°€ 있겠지. 해당 메소드가 library처럼 ëŠ�껴질때는 해당 코드가 ì�¼ì¢…ì�˜ 아키í…�ì³�ì �ì�¸ ë€ë„ì�´ ë�  때가 ì•„ë‹�까. 즉, Server/Client ì—�서ì�˜ Socket Connection ë€ë„ì�´ë�¼ë�˜ì§€, DB ì—�서ì�˜ DB Connection ì�„ 얻어오는 ë€ë„ì�€ 다른 코드들ì�´ 쌓아 올ë�¼ê°€ëŠ”ê²Œ 기반ì�´ ë�˜ëŠ” ë€ë„ì�´ë‹ˆê¹Œ. Application ì˜�ì—­ì�´ ë�˜ëŠ” ë€ë„ê³¼ library ì˜�ì—­ì�´ ë�˜ëŠ” ë€ë„ì�´ 구ë„ë�˜ë ¤ë©´ ë˜� 쉽진 않겠지만.

ì�´ë²ˆê¸°íšŒì—� comment, document, source code ì—� 대해서 제대로 ìƒ�ê°�í•´ë³¼ 수 있ì�„듯 (프로그램ì�„ 어떻게 ë„ì„�í•  것ì�¸ê°€ ë�¼ë�˜ì§€ Reverse Engineering Tool들ì�„ ì�´ìš©í•˜ëŠ” 방법ì�„ ê¶�리한다ë�˜ì§€ 등등) 그리고 후배들과ì�˜ 코드ì—� 대한 대화는 ì�µìˆ™í•œ comment 로 대화하는게 낫겠다. DesignPatterns ê°€ 한서ë�„ 나온다고 하며 ë˜�하나ì�˜ 기술장벽ì�´ 내려간다고 하ë�”ë�¼ë�„, ì ‘í•´ë³´ì§€ 않ì�€ 사람ì—�ê²� ë˜�하나ì�˜ 외국어ì�¼ê²ƒì�´ë‹ˆ. 그리고 ì˜�ì–´ê°€ 모국어가 아닌 ì�´ìƒ�. ë­�. (암튼 오늘 ë‚´ì�¼ ë�˜ëŠ”ëŒ€ë¡œ Documentation 마저 남기겠ì�Œ. 글쓰는 ë�„중 치열하게 Documentationì�„ 진행하지ë�„ 않ì�€ 사람ì�´ ë§�ë§Œ 앞섰다란 ìƒ�ê°�ì�´ 그치질 않는지ë�¼. 물론 작업중 Doc ì�´ 아닌 작업 후 Doc ë�¼ëŠ” ì �ì—�서 ì �수 깎ì�¸ë‹¤ëŠ” ì �ì�€ ì�¸ì§€ì¤‘;) --ì„�천

DeleteMe)위� 좌절� �유를 안�놨는�, �세히 � 종류별로 ��� �어 놓았는�, commit시� 충�� 나서 먹어 버렸어. 하..하..하 ... 암튼 �번� 프로그래�� 하면서 ��한 컨셉들� 서로 설명하면서 같� �해야 겠군.

그리고 계� �야기 하다보니 주�(comment)과 ~cpp JavaDoc� 나누어 설명하는 것� 올바른 ���듯 하다. 그런 관���면 �번 코딩� 컨셉� 녹색글� 최소주�로 나갔다고 볼수 있다. 머리�으로는 특별히 둘� 나누지 않고 있었는�, 코딩 습관�서는 완전히 나누고 있었�거 같다. 녹색 글�를 쓰지 않�려고 발악(?)� 했으니.. 그래� 보�는 녹색 글�들 보면 죄��� �것� object world�서 �하는 "프로그래머� 죄��"� 해당하는 것� 아�까. --�민
DeleteMe) ë€ì—°ì„¤ëª… : 녹색글ìž�는 Eclipse ì—�서 ë‚´ë€ ì£¼ì„�ì—� 대당. IntelliJ 는 ì�¼ë°˜ì �으로 회색. Vi ì—�서ì�˜ Java Syntax ì—�ì„  파란색.


재미있는 주�

주�� 실행� 수 있는 코드가 아니기 때문�, 반드시 코드가 주�대로 수행�다고 볼 수는 없지만 없는것 보다는 낳� 경우� 많다. 코드 �체는 언어� subset �기 때문� 아무리 코드가 �야기한다(code tells)� 할지�� 우리가 쓰는 언어� �해�� 미치기가 어렵다. �는 마치, 어떤 �� 함� 있어서 메뉴얼� 존재함�� 불구하고 경험��게 �야기를 듣고 메뉴얼� 볼 경우, 그 �해가 쉽고 빠르게 �는것과 비슷하다.

프로그램� 있어 주�� 하는 순기능� 하나 � 찾아볼 수 있다. 메마른 코드��서 사람� 숨결� ��게 해준다. 유머가 없는 세�� ��해보�. 얼마나 ��한가.

예를 들어 다�� 코드를 살펴보�(회사�서 누군가 작성한 코드)


~cpp 
...
		// ��들 다 쥑�고...
		CSmilNode* pChildNode = m_pFirstChild;
		while(pChildNode)
		{
			CSmilNode* pDelNode = pChildNode;
			pChildNode = pChildNode->m_pNext;
			pDelNode->deleteSafely(bRecursive);
			pDelNode = NULL;
		}

		// 형제� 연� 다 �고...
		if(m_pPrev)
			m_pPrev->m_pNext = m_pNext;
		if(m_pNext)
			m_pNext->m_pPrev = m_pPrev;

		// ë€ëª¨ì�˜ ì—°ë�„ ë�Šì�€ 다ì�Œ...
		if(m_pParent  &&  m_pParent->m_pFirstChild == this)
			m_pParent->m_pFirstChild = m_pNext;

		// �살한다.
		delete this;
...

� 다른 예� 있다.


~cpp 
...
// MODE_ADDBEFORE� 때는, newnode가 this� ��� brother� 바로 윗형으로 입양� 간다.
// MODE_ADDAFTER� 때는, newnode가 this� ��� brother� 바로 아래 ��으로 입양� 간다.
// ìž…ì–‘ì�„ 갈때, ìž�ì‹�들ì�€ í•­ìƒ� ë�°ë¦¬ê³  다니지만, ë€ëª¨ë‚˜ 형제와는 떨어지는 것ì�„ ì›�칙으로 한다.
// 새ì‹�구를 ë°›ì�„때, 먼저 ë€ëª¨ ìž�ì‹�ê°„ì�˜ 관계를 정립한 다ì�Œ, 형제간ì�˜ 서열ì�„ 정립한다.
//
// Default Parameter
//	nMode = MODE_ADDBEFORE
//	brother = NULL
// Constraint
//	brother는 반드시 NULL�거나 this� child node�어야 한다.
// 사용예
//	addChild(newnode, MODE_ADDAFTER, brother);		//newnode가 brother 바로 뒤� 삽입�다.
//	addChild(newnode, MODE_ADDBEFORE, brother);		//newnode가 brother 바로 앞� 삽입�다.
//	addChild(newnode, MODE_ADDAFTER);				//newnode가 first child로 삽입�다.
//	addChild(newnode, /*MODE_ADDBEFORE*/);			//newnode가 last child로 삽입�다.
//
CSmilNode* CSmilNode::addChild(CSmilNode* newnode, DCLADDMODE nMode, CSmilNode* brother)
//	this = ë‚´(ë€ëª¨)
//	newnode = ��(새놈)
//	brother = (this� ���)윗형
...

ì�´ì„ ìš°ëŠ” ì�´ëŸ¬í•œ 코드를 ë³´ë©° ì—¬ëŠ�때와 ê°™ì�€ 지루함ì�„ ëŠ�ë�¼ì§€ 못했다. (모든 주ì„� 없는 코드가 다 지루하다는 뜻ì�€ 아니다. ë„명 예술ì �ì�¸ 코드는 코드 ìž�체로 신비롭다. 문제는 ì�´ëŸ° 코드를 ìž�주 만나기 어렵다는ë�° 있다.) ì •ë§�, 재미있지 않ì�€ê°€?

우리는 ì¶©ë„히 ì�´ì„±ì �ì�´ê¸°ì—� 주ì„� ìž�ì²´ë§Œì�„ ë³´ê³  모든것ì�„ 믿으려고 í•  ë§Œí�¼ 어리ì„�지는 않다. 주ì„�ì�„ 먼저 ê±°ì³�ê°„ 사람ì�˜ 숨길로 ëŠ�ë�¼ê³ , 재미로 ëŠ�ë‚„ 수 있게 ë�˜ë©´ 코드 리뷰가 í•­ìƒ� 지루하지는 않ì�„ 것ì�´ë‹¤.

코드 ìž�체로서 ì�˜ë¯¸ë¥¼ ì�´ì•¼ê¸°í•  수 있ë�„ë¡� ì�´ë¦„ì�„ 잘 짓는 것ì�€ ë„명 중요하지만, ê·¸ì—� 못지 않게 코드를 ì�½ê³  작성하는 주체가 사람임ì�„ ìƒ�ê°�할때 주ì„�ì�€ ì�´ë“¤ì�„ 위한 ìž‘ì�€ ë°°ë ¤ë�¼ í•  수 있다.

--�선우

See Also Seminar:CommentOrNot , NoSmok:DonaldKnuth 's comment on programs as works of literature
Valid XHTML 1.0! Valid CSS! powered by MoniWiki
last modified 2021-02-07 05:31:26
Processing time 0.0275 sec