✅ 언어별 상황별(함수, 조건문, 반복문, 예외 처리 등) 주석 예시 모음
🟦 C# 주석 예시
/// <summary>
/// 클라이언트 연결을 수락하고 처리하는 서버 루프
/// </summary>
private void RunServer()
{
try
{
// 포트에서 수신 대기 시작
tcpListener = new TcpListener(IPAddress.Any, port);
tcpListener.Start();
while (true)
{
// 클라이언트 연결 수락 (블로킹)
connectedClient = tcpListener.AcceptTcpClient();
// 연결된 클라이언트 처리
HandleClient(connectedClient);
}
}
catch (Exception e)
{
// TODO: 에러 로깅 강화 필요
Debug.LogError("Server error: " + e.Message);
}
}
🟨 Java 주석 예시
/**
* 두 숫자를 더하는 메서드
* @param a 첫 번째 숫자
* @param b 두 번째 숫자
* @return 합계
*/
public int add(int a, int b) {
return a + b; // 단순 덧셈
}
try {
// 파일을 열고 읽기 시도
BufferedReader reader = new BufferedReader(new FileReader("data.txt"));
} catch (IOException e) {
// FIXME: 예외 발생 시 사용자에게 안내 메시지 필요
e.printStackTrace();
}
🟦 Python 주석 예시
def calculate_tax(price, rate):
"""세금 계산 함수"""
return price * rate # 세금 비율을 곱해서 계산
# 리스트에서 중복 제거
unique_items = list(set(items))
try:
# 사용자 입력을 숫자로 변환
value = int(input("Enter a number: "))
except ValueError:
# 잘못된 입력 처리
print("숫자를 입력해야 합니다.")
🟧 JavaScript 주석 예시
// 사용자 로그인 상태 확인
if (user.isLoggedIn()) {
// NOTE: 향후 세션 만료 체크도 추가해야 함
showDashboard();
} else {
redirectToLogin();
}
/**
* 배열에서 최대값을 찾음
* @param {number[]} arr - 숫자 배열
* @returns {number} 최대값
*/
function findMax(arr) {
return Math.max(...arr);
}
🟩 C/C++ 주석 예시
// 버퍼 초기화
memset(buffer, 0, sizeof(buffer));
// TODO: malloc 실패 시 처리 필요
char* data = (char*)malloc(100);
/**
* 두 수를 곱하고 반환
*/
int multiply(int a, int b) {
return a * b; // 간단한 곱셈
}
✍️ 추가 팁: 주석 스타일 템플릿 (자주 쓰는 패턴)
// TODO: 아직 구현되지 않은 기능
// FIXME: 여기서 버그 발생 가능
// NOTE: 중요한 주의사항
// HACK: 임시 해결 방법 (나중에 개선 필요)
// REVIEW: 동료 검토 요청
🔚 마무리
이런 주석 스타일을 익혀두면:
- 협업 시 소통이 쉬워지고
- 오랜 시간이 지나도 코드 해석이 쉬워지며
- 실무에서도 신뢰받는 코드 작성자가 될 수 있어요.
'STUDY > 코딩공부' 카테고리의 다른 글
[코딩공부] ✅ 잘 쓰는 주석 가이드라인 (0) | 2025.05.31 |
---|