Convention - Heart-Lee/server GitHub Wiki

정의 되지 않은 컨벤션은 각 언어, 프레임워크의 기본 컨벤션을 기준으로 한다.

일반 클래스명은 PascalCase 를 사용하며, 파일명을 클래스명과 일치시킨다. 함수/메서드명은 camelCase 를 사용한다. 변수명은 snake_case 를 사용한다. 명시적으로 함수와 구분하고, DB 컬럼명과 컨벤션을 맞추기 위함이다. 단, 변수에 함수/메서드가 레퍼런스되는 경우 예외적으로 camelCase 를 사용할 수 있다. if, for, use, catch 와 같은 키워드 다음 괄호를 쓰는 경우 스페이스 한칸을 띄운다. 키워드는 함수가 아니다!!!! 잘못된 예시: if(true), while(true)  함수/메서드의 괄호는 항상 붙여쓴다. 가급적이면 들여쓰기가 너무 깊이 들어가지 않도록 항상 신경쓰자!!

PHP/Laravel 정의 되지 않은 내용은 공식 PHP/Laravel 컨벤션과 예제 코드를 기준으로 한다. 들여쓰기: 스페이스 4칸 클래스가 아닌 일반 스크립트 파일명은 snake_case 를 사용한다. 클래스와 함수의 { 는 한 라인 내리고, 나머지 경우는 같은 라인에 붙인다.

/**
 * 클래스는 PascalCase
 */
class SomeClass 
{
    /**
     * 함수는 camelCase, 변수는 snake_case
     */
    public function someMethod($some_arg) 
    {
        // 한줄인 경우 { } 없이 같은 라인에 쓸 수 있다.
        if (! $some_arg) echo('null');

        /*
         * 내부 멀티라인 주석은 /* 로 시작
         */ 
        if ('true' == $some_arg) {
          return echo($some_arg);
        } else {
          return echo('error');
        }
    }
}

JavaScript/NodeJS 정의 되지 않은 내용은 공식 Javascript 컨벤션과 예제 코드를 기준으로 한다. 들여쓰기: 스페이스 2칸 클래스가 아닌 일반 스크립트 파일명은 snake_case 를 사용한다. ; 를 안써도 되는 버전의 경우 쓰지말자. 1바이트라도 아끼자. Promise 제어는 되도록 async/await 를 사용한다.

/**
 * 클래스는 PascalCase
 * 클래스/함수의 멀티라인 주석은 /** 로 시작
 */
class SomeClass {
  /**
   * 함수는 camelCase, 변수는 snake_case
   */
  function someMethod(some_arg) {
    // 한줄인 경우 { } 없이 같은 라인에 쓸 수 있다.
    if (! some_arg) console.log('null')

    /*
     * 내부 멀티라인 주석은 /* 로 시작
     */ 
    if ('true' == some_arg) {
      return console.log(some_arg)
    } else {
      return console.log('error')
    }
  }
}

HTML/CSS 정의 되지 않은 내용은 공식 HTML/CSS 컨벤션과 예제 코드를 기준으로 한다. 구글 스타일 가이드: https://google.github.io/styleguide/htmlcssguide.html  들여쓰기: 스페이스 2칸 id, class 명은 kebab-case 를 사용한다. 또한 되도록 표시방식에 따른 이름보다는 해당 엘리먼트의 목적과 의미에 따른 이름을 붙이길 권장한다. HTML은 최대한 XML 문법에 따르고, 다큐먼트의 구조가 명시적으로 보일 수 있도록 최대한 간단하게 태그를 구성한다.