코드 규범 셸

1392 단어
코드 규범
1. 소개
왜 코드 규범 이 있어 야 합 니까?코드 는 누구 에 게 보 여 줍 니까?다른 사람의 코드 를 너 는 알 아 볼 수 있 니?
2. 코드 유지 가능성
간단명료 하고 알 기 쉬 우 며 필요 한 주석 은 스타일 을 일치 시 킵 니 다.
3. 코드 규범 내용
3.1 명명
- 文件命名
- 函数命名:和实现功能一致
 小写, 动词_名词, 如:search_key, download_zone
- 全局变量命名:有意义
  大写 以下划线连接:YETI_SERVERS
- 局部变量命名
   小写,短促,能够精确表达意思

3.2 코드 들 여 쓰기 와 정렬 방식
  • 함수 체: 4 개의 빈 칸, 줄 당 80 개의 문자, 길 이 는 50 줄 안의 서로 다른 기능 블록 사 이 를 빈 줄 로 구분 합 니 다
  • if, while, for, case: 4 개의 빈 칸 들 여 쓰기
  • 3.3 주석
  • 각 스 크 립 트 파일 기능 설명: 스 크 립 트 가 무엇 에 사용 되 는 지 설명 합 니 다
  •    #!/bin/bash
       #
       # Perform hot backups of Oracle databases.
    
  • 각 함수 기능 설명: 함수 의 기능 소개
  • 관건 적 인 절차 주석
  • 3.4 모듈 화
  • 함수 기능 단일: 한 가지 만 하기
  • 전달 매개 변수
  • 하 드 코딩 없 음
  • 중복 코드 제거
  • 가능 한 한 국부 변수 사용
  • 매개 변 수 를 최대한 전달 하고 전체 변 수 를 적 게 사용 합 니 다
  • 유지 코드 가 간단 하고 간단 하 다
  • 4. 함수 테스트
    각 기능 점 에 대해 완전한 테스트 를 실시 하여 각종 이상 상황 을 테스트 합 니 다. 1. 네트워크 이상 2. 하 드 디스크 는 반환 값 을 가득 쓰 고 검 사 를 하여 함수 의 기능 이 완전 하 게 실현 되도록 테스트 사례 를 반복 적 으로 실행 해 야 합 니 다.
    5. 로그 처리
    디 버 깅 로그 기록 관건 실행 프로 세 스 로그 관건 오류 경고, 주파수 로그 출력: syslog, 파일 기록
    6. 자주 사용 하 는 디 버 깅 기술
    1. 打印变量值
      查看是否获取到需要的值
    2. 包装日志输出函数: 
        打印执行时间,文件名,函数名,出错行数等
    3. 关键流程日志输出到文件中
    

    7. 상용 코드 세 션
    1. 参数解析:
    

    8. 문제 의 근원 찾기
    9. 참고 문서
  • google shell style
  • 좋은 웹페이지 즐겨찾기