주석

1. 법적 정보

2. 의도를 명확하게 설명할 때!

2.1. 네이밍으로 설명이 다 불가능할 때!

# 스레드를 10개 늘린다.
for i in range(10):
    thread = threading...

3. 경고

# WARNING: API 서버가 항상 양호한지 알 수 없음
def connectApiServer():
    ....

4. TODO

# TODO@who : who에게 전달할 메세지
class Client:

5. FIXME

• FIXME: 치명적인 에러를 발생하는 코드는 아니지만 수정 필요 할 때

class Client():
    # FIXME: 반복문 줄이기
    for i in range(10):
        for j in range(10):
            ....

C / Javascript

/* ============================================================
* main.js
* http://
* ============================================================
* Copyright 2011-2014 ****, Inc.
* Licensed under ***
* ============================================================ */

/*
#=========================================#
|   copy 부분 사용자 정의 해준다.          |
#=========================================#
*/

/*
*-------------------------------------------------------------------*
|                   copy 부분 사용자 정의 해준다.                    |
*-------------------------------------------------------------------*
*/

css

// * -------------------------------
// * class modules definition
// * -------------------------------

// * -------------------------------
// * Image Replace(IR)
%ir {
  display: block;
  overflow: hidden;
  text-indent: -999em;
}

python

• 
• print(XX.__doc__) 으로 표시됨

bash shell

################################################################################
#
# BEGIN: declarations
#
# Variables used to control parameters and behavior of all types of jobs.
# It's written in this form to allow particular job to change the value.
# e.g. particular jenkins job can export BUILD_ENABLE_BOM="Y" to enable
# BOM files generation and it will override not only the default value
# but also set_enable_bom function won't be called to assign it based on
# currently running type of build.
#
################################################################################