Coding Convention - tamagoyakii/minishell GitHub Wiki

Coding Convention

  1. norminette-v3.3.51 을 기준으로 한다.
  2. Naming Rules
    • 변수명
      • 최대한 짧게 하지만, 의미는 담겨 있도록
      cnt_대상	// 숫자를 세는 변수
      구조체s	// 구조체 리스트
      배열s	// 이중 배열
      seek	// list의 주소를 유지한 상태로 list->next로 조건문을 사용해야 하는 경우
      
    • 함수명
      • 동사_목적어 형태
    • 파일명
      • 동사_목적어 형태
      • 같은 목적의 파일이 많을 경우 동사_목적어_2 형태로 파일 추가
    • 약어 정리
      redirection => redir
      heredoc => hdoc
      command => cmd
      iteration => i
      list => lst
      result => res
      // 코드 작성하면서 추가 예정
      
    • while문에 i를 증가하면서 진행할 때는 다음과 같은 형식으로 작성
      i = -1;
      while (++i < 임의의 수)
      {
          // 코드
      }
      
    • malloc할당 시 NULL 가드를 할 때 다음과 같은 형식으로 작성
      변수 = malloc();
      if (!변수)
          return();