"개발자의 글쓰기"를 읽다가 함수명을 명명할 때 자주 사용되는 동사 표현들이 나와서 정리해봤다. 아직 현업 경험이 없는 나는 이렇게 세세한 어감까지 신경써본적은 없지만 (보통 번역기나 chatGPT 선에서 해결함), 실무에서는 네이밍으로 고민을 많이 한다고 들었다. 명명할 때 정확한 표현을 쓰면, 사용자 입장에서는 어떤 용도로 사용되는 함수인지 이해가 쉬울 것 이다.
1. 반의어
보이다 ↔ 감추다
show ↔ hide
visible ↔ invisible
열다 ↔ 닫다
open ↔ close
전 ↔ 후
before ↔ after
미만, 초과
under, over
이하, 이상
or under, and over
2. 유의어
중단하다
stop ↔ start, restart | 잠시 중단, 언제든 재시작 가능 | |
end ↔ begin | 완전히 중단, 재시작할 가능성 없음 | endUserRegister(); // 사용자 등록을 종료, 사용자 등록을 새롭게 시작하려면 beginUserRegister() 를 호출 |
finish | 완전히 중단, 재시작을 고려할 필요 없음 | finishUserRegister(); // 사용자 등록이 완전히 종료, 이 함수 실행 뒤 다시 사용자 등록을 요청하면 에러가 발생해야함 |
pause | 잠시 일시적으로 중단 | |
suspend | 다음 단계의 시작을 중단 | |
hold | 어떤 의도가 있어서 중단 |
값을 가져오다
get | 어떤 값을 돌려받아서 반환함 |
retrive | ‘검색’해서 가져옴 |
acquire | 다른 함수가 가져가지 못하게 독점함 |
fetch | 현재 값을 가리키는 포인터가 다음 값으로 이동한 것을 가져옴 |
설정하다/생성하다
set | 값을 변경하거나 설정 |
init | 초기화 |
create | 정해진 틀을 만드는 것 |
register | 정해진 틀에 값을 넣는 것 |
수정하다
change | 내용을 단순히 변경 |
modify | 잘못된 것을 바로잡음 |
revise | 새로운 정보나 아이디어가 추가되어 기존 내용과 달라짐 |
3. 네이밍 시 참고할만한 사이트
'TIL' 카테고리의 다른 글
SLOW QUERY 란? 성능 개선은 어떻게 이루어지는지 (0) | 2024.05.03 |
---|---|
JPA 단방향 연관관계, 양방향 연관관계 (1) | 2024.04.28 |
JPA 연관관계 매핑 (0) | 2024.04.27 |
Java 기초 문법(2) (0) | 2024.02.19 |
Java 기초 문법 (1) (0) | 2024.02.18 |