8. 코딩 가이드 라인

XE 코딩 가이드 라인^#

PHP태그^#

PHP태그는 <?php 로 시작하여 ?> 로 끝나는 것을 원칙으로 한다.

들여쓰기^#

tab대신 4개의 공백 들여쓰기

1. vi 설정 (.vimrc)

   set sts=4
   set sw=4

제어구조^#

제어문의 조건 연산자 중 ||. &&, !=, == 등은 전후로 한칸씩 띄워 구분하고 블럭의 시작 구분자는 개행을 하지 않고 씀을 원칙으로 한다.

단, 조건문이 많아질 경우 상황에 맞게 개행으로 구분을 할 수 있다.

1. if($a == 1 || $b == 2) {
       ....
   } elseif($c == 1) {
       ...
   } else {
       ..
   }

주석(PHPdoc)^#

주석(PHPdoc)은 doxygen의 양식에 맞추기 위하여 아래와 같은 형식을 준수해야 한다.

1. 클래스 파일

1. /**
   * @class 클래스이름
   * @author 이름 (메일)
   * @brief 간략한 설명
   *
   * 자세한 설명
   **/

2. 함수 혹은 기타 php코드가 사용된 파일

1. /**
   * @file 파일경로/파일이름 (ZBXE의 root부터 시작)
   * @author 이름 (메일)
   * @brief 간략한 설명
   *
   * 자세한 설명
   **/

3. 함수(!method)의 주석

1. /**
   * @brief 간략한 설명
   * @param 인자1
   * @param 인자2
   * @return return type
   **/

class 정의^#

클래스의 파일과 이름은 각 단어를 대문자로 시작함을 원칙으로 한다.

1. class EditorHandler { ... }

method 정의^#

클래스의 메쏘드는 각 단어를 대문자로 시작하되 첫 단어는 소문자로 시작하고 가능한 약어를 사용하지 않는다.

1. function setInfo($info) { ... }

변수 사용^#

변수는 소문자로만 사용하고, 각 단어간 _ 로 연결을 하며 가능한 약어를 사용하지 않는다.

1. $module_info

상수 사용^#

상수는 무조건 대문자로만 사용하고, 각 단어간 _ 로 연결을 하며 가능한 약어를 사용하지 않는다.

1. IS_INSTALLED