The KIPS Transactions:PartD (정보처리학회논문지D)

Korea Information Processing Society (한국정보처리학회)
권호 표지
DOI QR코드

DOI QR Code

An XML-based Comment Management System for C Source Code

XML에 기반을 둔 C 원시 코드의 주석 관리 시스템

  • 박근옥 (공주대학교 대학원 컴퓨터공학과) ;
  • 임종태 (공주대학교 컴퓨터공학과)
  • Published : 2004.08.01
Download PDF
⟨ Previous Next ⟩

Abstract

Well documented, simplified and clarified source code is required for the mission critical application software area in which C programing language is generally used. We suggest an XML_based comment management system for C source code. The comment management system is composed of 6 modules including comment user module, reviewer module, comment extraction module, comment traceability link module, comment tag definition module and storage management module. The XML comment tags defined in this paper cover categories of the development process activities applying the IEEE standard 1028 and IEEE standard 1012. The XML Schema Is used to insert comments into C source code and to extract XML tags from C source code and the XSL-FO is used fur the visual display professing o( comment extraction results.

C 언어가 주로 사용되는 미션 크리티컬 응용 소프트웨어 영역에는 문서화, 간결성, 정확성을 갖는 원시 코드가 요구된다. 본 연구는 XML 기반의 C 원시 코드의 주석관리 체계를 제안한다. 이 주석 관리체계는 주석 사용자 모듈, 검토자 모듈, 주석 추출 모듈, 주석 추적 연계 모듈, 주석 태그 정의 모듈, 저장관리 모들을 포함하는 6개 모듈로 구성된다. 본 연구에서 정의된 XML 주석 태그는 IEEE 표준 1028과 IEEE 표준 1012를 적용하는 개발공정 활동의 범주를 포함한다. C 원시 코드에 주석을 삽입하고 추출하기 위하여 XML 스키마가 사용되며. 주석 추출 결과의 시각적 표시 처리를 위하여 XSL-FO가 사용된다.

Keywords

References

  1. 윤 청, 성공적인 소프트웨어 개발방법론(하권), 생능출판사, 1998. 6. 30
  2. R. S. Pressman, Software Engineering - A Practitioner's Approach, McGraw-Hill 4th Edition, 1998
  3. IEEE Standard 1028-1997, Software Reviews
  4. IEEE Standard 1012-1986, Software Verification and Validation Plans
  5. N. Marovac, 'Guidelines for Embedded Software Documentation,' ACM SIGSOFT, Software Engineering Notes, Vol.19, No.2, pp.22-28, 1994 https://doi.org/10.1145/181628.181632
  6. 문양선, 장근실, 유철중, 장옥배, 'C++ 프로그램의 유지보수 지원 시스템 개발', 정보처리논문지, 제5권 제7호, pp. 1759-1773, 1998
  7. G. Antonioi and G. Canfora, 'Recovering Traceability Links between Code and Documentation,' IEEE Trans. on Software Engineering, Vol.28, No.10, pp.970-983 https://doi.org/10.1109/TSE.2002.1041053
  8. D. Bargeron, A. Gupta and A. Brush, 'A common annotation framework,' MSR-TR-2001-108, Microsoft, 2001
  9. 조현훈, 최용락, 류성열, 'McCabe 및 BP/Win 도구를 이용한 소프트웨어 역공학 사례연구', 한국정보과학회논문지, 제6권 제5호, pp.528-535, 2000
  10. 주현훈, 류성열, '소프트웨어 재사용을 위한 역공학 기반의 재문서화 방법 및 프로세스', 한국컴퓨터산업교육회지 논문지, Vol.3, No.6, pp.727-738, 2002
  11. 장근실, 유철중, 장옥배, 'JML을 이용한 Java 원시 코드의 역공학/순공학적 접근', 한국정보과학회논문지, 제30권 제1호, pp.19-30, 2003
  12. J. Sharp and J. Jagger, Microsoft Visual C#.NET, Microsoft Press, 2002
  13. W3C, XMl Recommendation, http://www.w3.org/XMl/Schema
  14. W3C, XSL Recommendation, http://www.w3.org/TR/XSL/
  15. Jon Duckett, Professional XML Schemas, Wrox Press Ltd., 2002
  16. Eric, V. D. V., 'Comparing XML Schema Languages,' XML. com, Dec., 2001
  17. http://www.antennahouse.com/
  18. http://xml.apache.org/dist/xalan-j/
  19. W3C, XMl Recommendation, http://www.w3.org/MarkUp/Forms/