소스코드
-
소스코드 주석(comment)에 대한 짧은 글Think 2023. 3. 5.
위키피디아에 의하면 주석이란 소스 코드를 더 쉽게 이해할 수 있게 만드는 것이 목적인 메모를 말한다. 주석 또는 코멘트는 프로그래밍에 있어 내용을 메모하는 목적으로 쓰인다. 소스 코드를 더 쉽게 이해할 수 있게 만드는 것이 주 목적이며, 협업할 때 유용히 쓰인다. 컴파일러와 인터프리터에 의해 일반적으로 무시되어 프로그램에 영향을 주지 않는다. 위키백과 하지만 주석 때문에 소스코드를 더 이해하기 어려울 수 있다. 예를 들어, 1. 코드의 의도가 명백하여 오히려 주석이 중복 내용에 가깝다. "XX를 출력합니다, XX를 가져옵니다. XX를 처리하고 응답합니다."등이 있다. 2. 주석이 관리가 되지 않아 소스코드의 내용과 전혀 다른 설명을 하게 된 경우이다. 너무나도 슬픈 사실인데 소스코드를 수정하는 사람이 주..
-
블로그에서 소스코드를 가독성있게 출력하는 방법. SyntaxHighlighterBlog Tips 2011. 11. 2.
저의 경우 블로그에 간략한 예제에 대한 C 소스코드와 shell 스크립트의 내용들을 포스팅 내용에 간간히 포함시키곤 한다. 그럴 때 마다 HTML 수정에서 직접 태그를 주어서 하나의 문단으로 묶어주고 가독성을 위해 앞뒤 글과의 차이를 두고 재확인하는 작업을 했었다. 자료를 찾아보니 많은 사람들이 적용한 SyntaxHighlighter라는 프로그램을 찾았다. http://alexgorbatchev.com/SyntaxHighlighter/ SyntaxHighlighter는 자바 스크립트를 통해 태그 안에 약속된 아이디(class)에 어떤 소스코드인지를 명시해두면 소스코드 작성 편집기에서 표현해주는 퀄리티의 소스 코드를 웹에서 확인할 수 있다. 위의 이미지에서 Demo 부분처럼 말이다. 자 그렇다면, 이제 설..