Bash 주석 가이드

Bash 주석 가이드, 배쉬 코멘트 가이드

1 파일 헤더

#!/bin/bash
#
# Perform hot backups of Oracle databases.

2 함수 주석

#######################################
# Cleanup files from the backup dir
# Globals:
#   BACKUP_DIR
#   ORACLE_SID
# Arguments:
#   None
# Returns:
#   None
#######################################
cleanup() {
  ...
}

3 구현 주석

• 중요한 것, 적절히, 재밌게(!)

4 할일 주석

• 임시 코드에 대해, 해결방법 짧게 기술, 완벽하지 않아도 됨

# TODO(mrmonkey): Handle the unlikely edge cases (bug ####)

5 같이 보기

• bash
• 주석
• 쉬뱅
• Java 주석 가이드

6 참고

• https://google-styleguide.googlecode.com/svn/trunk/shell.xml