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.0343 sec