본문 바로가기

프론트엔드 로드맵

프론트엔드 로드맵 10 - HTML 컨벤션과 모범사례

반응형

코딩 컨벤션이란?

코딩을 하는 프로그래머 사이의 규칙. 특히 여러명이 협업하는 과정에서 이 컨벤션을 통해 코드 스타일을 유지할 수 있다. 이 규칙을 지키면 가독성이 높아져 소스 코드를 처음 접하는 사람들도 빠르고 쉽게 이해할 수 있는데 도움이 된다. 유지보수에 이점이 있다. 

 

NHN이 제시한 코딩 컨벤션을 참조한다.

<코딩 컨벤션 요소>

1. 네이밍 규칙 : 이해하기 쉬운 이름으로 작성한다. 

2. HTML - 들여쓰기(보통 2칸/4칸 들여쓰기를 통일 시킨다), 빈 줄(빈 줄은 의미있는 객체를 구분하기 위해 사용되므로 남발하지 말자), DTD 및 인코딩 (어떤 버전의 HTML인지 어떤 문자 코드로 인코딩을 선언하는지 구분), 주석 (HTML 코드의 주석은 코드 그룹을 구분하거나 참고해야 할 때 기술)

 

<HTML 요소 작성 규칙>

HTML 요소 작성 규칙은 반드시 선언해야 하는 애트리뷰트와 선택적 사용이 가능한 애트리뷰트에 대한 내용을 기술한다.

 

이외에 컨벤션 방식은 아래 사이트에서 확인 가능하다.

 

바로가기 : https://nuli.navercorp.com/data/convention/NHN_Coding_Conventions_for_Markup_Languages.pdf

 

Daum이 제시한 코딩 컨벤션도 참조한다.

<문서 제목>

컨텐츠 제목과 서비스명 사이에는 마이너스가 아닌 ' - ' (&ndash;)가 사용된다. 검색 엔진 크롤링시 마이너스 기호가 들어가면 컨텐츠 제목을 정확히 뽑아내기 어렵다고 한다..

하위섹션명의 구분은 | 로 사용한다.

 

<레이아웃 가이드>

큰 레이아웃은 전체를 daumWrap으로 싸고 daumHead, daumContent, daumFoot으로 쪼갠다.

daumWrap을 relative하여 daumMinidum을 상단으로 올린다.

 

 

바로가기 : http://darum.daum.net/convention/html/html_convention

반응형