웹 페이지를 만들 때 코드 주석 작성 기준에 주의해야 합니다.

좋은 코딩 스타일은 웹페이지를 만들 때 명확한 아이디어를 가질 수 있도록 도와주며, 코드 주석에도 소소한 지식이 담겨 있습니다.

제가 작업에 사용한 주석 작성 기준을 정리했습니다. 사실 기술적인 내용은 없습니다. 통일된 제작 방법과 유지 관리를 용이하게 하는 기준에 주의하는 것이 가장 중요합니다.

이러한 경험에는 "지역 댓글", "한 줄 댓글", "댓글 수준" 및 "지원 댓글"의 네 부분이 포함됩니다. 대부분의 친구들이 사용하는 영역 주석 방법은 "주석 내용" 또는 "주석 내용 끝", "시작" 또는 "끝" 등으로 시작합니다. 이에 비해 "S" 또는 "E"로 시작하는 것이 더 빠를 수 있습니다. 예를 들어, 시작 또는 끝 주석을 한 번 쓴 다음 복사하고 "S" 또는 "E"를 변경하여 해당 영역의 주석을 빠르게 완성할 수 있습니다.

실제 작업에서는 Annotation을 Label의 위 또는 아래에 두어야 하는지 불명확한 경우가 있는데, 이런 상황을 피하기 위해 Region Label의 시작과 끝 앞뒤로 Annotation 정보를 일률적으로 기재하며, 앞에 "S"를 붙인다. " 또는

"

예:

<!--=S 댓글 내용-->
<div>
...
</div>
<!--=E 댓글 내용-->

/*=S 댓글 내용*/
.수업{
...
}
.수업{
...
}
/*=E 코멘트 내용*/

코멘트가 필요한 내용 영역에는

한 줄 코멘트

예:

<div>
<!--댓글 내용-->
...
</div>

.class{
/*댓글 내용*/
...
}

주석 수준

모듈 생산에서는 영역 내에 영역이 있을 수 있습니다. 영역 간 수준을 더 잘 구분하기 위해 주석 수준이라는 개념이 도입되었습니다. 영역 설명 앞의 등호는 현재 설명의 수준을 나타냅니다.

예:

<!--=S 설명 내용-->
...
<!--==S 댓글 내용-->
...
<!--===S 댓글 내용-->
...
<!--===E 댓글 내용-->
...
<!--==E 댓글 내용-->
...
<!--=E 댓글 내용-->

/*=S 댓글 내용*/
...
/*==S 댓글 내용*/
...
/*===S댓글 내용*/
...
/*===E 댓글 내용*/
...
/*==E 댓글 내용*/
...
/*=E 댓글 내용*/

작성자가 아닌 사람이 유지관리할 때 추가된 수정 시간 및 수정자와 같은 식별 정보

에 대한 댓글 작성을 지원합니다

영역 설명 또는 한 줄 설명을 기반으로 수정자 및 수정 시간과 기타 정보를 추가합니다.

예시(영역 코멘트):

<!--==S 코멘트 내용 [수정자 및 수정 시간]-->
<div>
...
</div>
<!--==E 댓글 내용 [수정자 및 수정 시간]-->

/*=S 댓글 내용 [수정자 및 수정 시간]*/
.수업{
...
}
.수업{
...
}
/*=E 주석 내용[수정자 및 수정 시간]*/

예(한 줄 주석):

<div>
<!-- 댓글 내용 [수정자 및 수정 시간]-->
...
</div>

.class{
/*댓글 내용[수정자 및 수정 시간]*/
...
}