본 글에서는 Typora 라는 무료 마크다운(Markdown) 편집기(뷰어) 프로그램을 소개한다. 마크다운 언어는 서식 있는 텍스트 파일을 매우 쉽게 작성할 수 있는 언어이며, 아래 글에서 기본 사용법을 소개하고 있다. 2020/02/27 - [소프트웨어 개발 및 프로젝트 관리/문서화] - 마크다운(Markdown) 언어 사용법 Typora 의 특징은 다음과 같다. 마크다운 문법에 맞춰 작성하면, 바로 서식이 적용되어 표시된다. 마크다운 문법 뿐 아니라, 기존의 잘 알려진 단축키를 통해서도 서식을 적용할 수 있다. 무료이다. Typora 설치 Typora는 아래 공식 웹사이트에서 다운로드할 수 있다. Typora — a markdown editor, markdown reader. Readable & Wr..
본 글에서는 마크다운(Markdown) 언어의 사용법에 대해 소개한다. 마크다운(Markdown) 언어란? 마크다운(Markdown) 언어는 서식이 있는 텍스트 문서를 작성하는데 사용되는 언어이며, 매우 사용하기 쉽다. 특히 마우스나 단축키를 사용하지 않고 일반적인 키보드 입력만으로도 서식을 적용할 수 있기 때문에, 문서 작성자 입장에서 사용하기에 매우 편리하다. 단, 이러한 사용 편의성으로 인해 서식의 미려함이나 다양성이 부족한 측면은 있다. 즉, 마크다운 언어는 문서 작성자에게 초점을 맞춘 언어로 생각할 수 있다. 문서 작성의 어려움을 최대한 감소시켜 문서 작성을 귀찮아 하는 사람들에게 문서 작성에 대한 의욕을 고취시킬 수 있다. 이러한 편의성 때문에 개발자들이 문서를 작성하는데 많이 사용하고 있으며..
본 글을 포함하여 몇 편의 글을 통해 소프트웨어 소스코드 관련 문서 작성 자동화에 대한 내용을 소개한다. 문서 작성 자동화 환경은 전용 툴을 이용하여 구성할 수 있다. 분야별로 다양한 문서 작성 자동화 툴이 존재하지만, 본 글에서는 C++ 코드에 관련된 문서 작성 자동화 툴인 doxygen을 소개한다. doxygen이 C++ 만 지원하는 것은 아니며, 지원 가능한 언어는 doxygen 공식 홈페이지에서 확인할 수 있다. 문서 작성 자동화의 장점은 소프트웨어 코드 작성과 동시에 문서 업데이트도 가능하다는 것이다. 특히 애자일 프로세스에 따라 개발되는 소프트웨어의 경우 수정과 배포가 빈번하게 발생하기 때문에, 이에 맞춰 문서를 지속적으로 업데이트 하기 위해서는 매우 많은 노력이 필요하다. 문서 작성 자동화를..