문서의 임의 삭제는 제재 대상으로, 문서를 삭제하려면 삭제 토론을 진행해야 합니다. 문서 보기문서 삭제토론 주석(언어) (문단 편집) === [[프로그래밍]] 코드 === 코드를 짤 때 넣는 설명문이다. 코드를 읽는 사람으로 하여금 쉽게 이해할 수 있게 하기 위한 것으로 실행에는 영향을 미치지 않는다. 만약 주석이 없다면 코드를 짠 사람조차 대번에 이해하지 못하는 사태가 벌어질 가능성도 있기 때문에 코딩에서 [[필수요소]]로 꼽힌다. 특히 시스템이 정교해질 수록 프로그래머 개인이 감당하기 힘들 정도로 코드 수가 많아지고, 이에 따라 프로그래머 간 협업이 필수적으로 이루어짐에 따라 주석을 잘 다는 것도 프로그래머의 중요한 능력 중 하나로 평가받기도 한다. 비단 프로그래머들 간의 협업 뿐만 아니라 업무 인수인계 등에 있어서도 주석을 적절히 다는 것은 매우 중요하다. [[http://m.thisisgame.com/webzine/nboard/257/?n=61912|주석이 없을 경우 벌어지는 일]] 프로그래밍 언어마다 주석을 넣는 방식이 다른데, 예를 들어 [[C언어]], [[C++]], [[C#]], [[Java]]에서는 슬래시 두 개(//)를 연속으로 놓으면 한 줄에서 그 뒷부분은 모조리 주석으로 처리하고, {{{/* 주석 처리할 구역 */}}} 식으로 쓰면 사이에 있는 내용을 주석으로 처리한다. [[Ruby]]나 [[Python]]에서는 # 표시를 줄 앞에(혹은 줄 뒤에 주석을 짤막하게 넣고자 할 때 넣을 주석의 바로 앞에) 붙이는 것으로 하거나 주석 처리하고자 하는 문 앞뒤로 '''(작은 따옴표 3개)를 붙여서 주석 처리를 할 수 있고 [[BASIC]]에서는 특정 줄에서 REM 명령문 또는 작은따옴표(')를 찍으면 그 뒤로 주석처리된다. 프로그래밍 언어는 아니지만 [[마크업 언어]]인 [[HTML]]이나 [[XML]]에서도 주석 기능이 있는데, {{{}}} 이렇게 주석처리를 할 수 있다. 줄마다 맨 앞에 주석 처리를 넣는 건 주석처리 하려는 부분을 드래그하고 Ctrl + /를 누르면 된다. 나무위키에서도 적용되는 기능.[* Microsoft 입력기가 아닌 한글 입력기의 영어 입력 모드로 하면 작동하지 않기도 하는데, 그럴 땐 한영 키를 눌러 영어 입력 모드에서 벗어나거나 Ctrl + Shift로 입력기를 전환하면 된다.] 쓸모 없어진 구버전 코드를 삭제하지 않고 주석 처리하는 것은 [[코더|좋지 않은 습관]]으로, SonarQube 등의 코드 분석 도구에서도 주요 이슈로 처리하여 수정을 권장하고 있다. 코드의 가독성을 해칠 뿐만 아니라, 주석 처리된 코드가 풀리면 자칫 예기치 못한 오류를 발생시킬 수도 있기 때문. 구문 강조 기능이 기본 옵션으로 달려 있는 에디터라면 그나마 사정이 좋지만, 이 역시 실수로 주석 처리를 풀어버릴 위험성이 높고, IDE에서 편집하는 경우는 자동 포매팅으로 인해 해당 코드의 가독성이 저해될 가능성도 크다. 따라서 이런 코드는 최신 버전에서 과감하게 삭제하고, 대신 구버전은 [[git]] 같은 소스 관리 도구나 다른 곳에 [[백업]]하는 것이 옳다. 삭제는 해야 하는데 협업 특성상 곤란한 경우는 Java의 {{{@Deprecated}}} 같은 기능을 병용하여 삭제 예정 코드의 위치와 그 사유를 명시하고, 이후 참조가 모두 해제됐다면 그 때 과감하게 삭제하면 된다. 단순히 이 코드나 이 부분이 어떤 역할을 한다고 설명하는 역할 외에도 디버깅하는 상황에선 매우매우 유용한 도구이기도 하다. 만약 코드 어딘가에 문제가 있어서 원하는대로 실행이 안 되거나, 실행은 되는데 의도하지 않은 결과를 내놓는다면 어디가 문제인지 찾아내야 하는데, 주석을 이용해서 일정 구간을 주석 처리하여 실행되지 않게 만든 후, 다시 프로그램을 실행했을 때 진행이 막혀버리던 문제라던가가 해결되는 경우 주석 처리된 코드 내에 뭔가 문제가 있음을 알아낼 수 있다.저장 버튼을 클릭하면 당신이 기여한 내용을 CC-BY-NC-SA 2.0 KR으로 배포하고,기여한 문서에 대한 하이퍼링크나 URL을 이용하여 저작자 표시를 하는 것으로 충분하다는 데 동의하는 것입니다.이 동의는 철회할 수 없습니다.캡챠저장미리보기