Coding Convetion

coding convention의 7가지 요소

• 파일의 구성

• Naming Convention

• 들여쓰기

• 주석

• 선

• 명령문

• 공백

  파일의 구성

  자바 소스 파일의 경우 여러 sectionㅇ르 식별하는 주석으로 구성됩니다.
  2천줄 이상의 긴 단일 파일을 지양합니다
  소스 파일의 순서는 아래와 같습니다.

• 주석(Beginning Comments)

• Package & import

• Class 및 interface

  /*
  		Class name, date ...
  
  */
  package java.avaj
  import java.avaj.water
  
  public class Avaj extends ParentAvaj{
  
  }

  Name Convention

  각 Case의 사용은 언어와 프레임워크마다 다릅니다(Python:Snake, C++:Camel, Java:Camel, JS: Camel)

• Pascal Case [VarOfName] : 첫 단어를 포함한 각 합성어의 첫 글자를 대문자로 표기합니다.

• Camel Case [varOfName] : 단어의 첫 글자를 제외한 각 합성어의 첫 글자만 대문자로 표기합니다.

• Snake Case [var_of_name] : 단어 사이에 _를 사용하여 구분합니다.(Kebab은-)

  Java

• class 이름은 camel case

• method 명은 기본적으로 동사로 시작하며, 형변환 메소드의 경우 전치사(to 등)으로 시작
  ex)renderHtml(), toString()

  선언

• class import 시에는 * 없이 필요한 클래스 명을 명시적으로 작성

import java.util.List;

• 주석 사용을 위해서 하나의 선언문에서는 하나의 변수만을 다룹니다

들여쓰기

• 4개의 공백과 같도록 탭을 사용하여 들여씁니다

google code convention, IDE 적용

• google에서 xml 파일을 제공해주고 있어 IDE에 설정해두면 편하게 적용 가능합니다.
• google github에서 필요한 언어와 IDE환경에 맞는 파일을 다운로드 가능합니다
• ex) intellij-java-google-style.xml
• File->Setting->Editor->Code Style에서 설정

참고 : Kotlin Coding Convention, Google Java Style Guide, Java Code Convention - Oracle, Google TypeScript Style Guide