주석
주석이란. 코딩내용을 설명해주는 내용입니다. 그렇기에 실행코드에는 아무런 영향을 주지 않습니다.
하지만, 코딩 시 주석처리는 매우 중요합니다.
실무 프로젝트 시 여러 사람이 소스를 만지다 보면, 이 함수가 어떤 역할을 하는지 주석처리가 되어 있다면 빠르게 유지보수가 가능합니다. 하지만 그보다도 본인이 짠 코드도 한 1년 후 보면 긴가 민가 합니다.
그렇기에 그 당시에 수정한 날짜 및 해당 기능 및 수정사항에 대해서 자세히 적어두면 둘 수록 좋습니다.
귀찮다고 주석없이 짰다가 현재는 편할지 몰라도 어느 정도의 시간이 지나면, 인간의 뇌는 기억이 그리 오래 남지 않다는 것을 금방 알 수 있습니다. 그렇기에 주석은 메모와 유사하다고 생각 하면 됩니다.
비주얼스튜디오 웹 문서에 주석처리 하는 방법을 알아봅니다.
위와 같은 코드가 있다고 합시다.
<ol>태그는 odered list를 뜻한다는 주석을 넣고 싶습니다. 이럴 때는 주석 단축키를 사용하면 됩니다.
<body>
<!-- Odered list -->
<ol>
<li>나이키</li>
<li>아디다스</li>
<li>푸마</li>
<li>프로스펙스</li>
</ol>
</body>
주석을 원하는 코드에 커서를 둔 상태에서 Ctrl + / 를 입력하면 위 처럼 주석이 생깁니다.
html 파일의 경우 <!ㅡㅡ주석내용 ㅡㅡ> 이런식의 주석 내용이 자동으로 입력됩니다.
당연히, 주석은 실행되는 코드가 아니기에 결과값에는 반영되지 않습니다.
주석을 해제하기 위해서도 주석된 코드 부분에 Ctrl + / 를 입력하면 주석이 사라집니다.
CSS 및 자바스크립트 의 주석시에도 주석코드를 외우지 말고 Ctrl + / 를 입력하면 됩니다.
참고로, 3언어의 주석코드는 하기와 같습니다.
html
<!ㅡㅡ주석내용 ㅡㅡ>
CSS
/* 주석내용 */
JS
// 주석내용
/* 주석내용 */
주석을 잘 활용해서 나중에도 손쉽게 이해가 가는 유지보수가 용이한 코드를 짜면 좋겠습니다.
감사합니다.
'앱 만들기 > 비쥬얼스튜디오 코드' 카테고리의 다른 글
VSC 한줄복사 단축키 (1) | 2023.07.05 |
---|---|
VSC 자주사용되는 유용한 단축키 (6) | 2023.05.29 |
비쥬얼스튜디오 코드 탭 사이즈 조정하기 (6) | 2023.01.23 |
비쥬얼스튜디오 코드 html 기본 태그 생성방법 (4) | 2023.01.22 |
비주얼스튜디오코드 색 테마 변경 하기 (4) | 2023.01.07 |
댓글