본문 바로가기
IT/아키텍처

네이밍 룰 - 메소드 [2편, 단어]

by ^&**&^ 2022. 5. 26.
반응형

1편에 이에 2편입니다. 

 

네이밍 룰 - 메소드 [1편, 기본편]

개발자가 코딩시 가장 난해하게 생각하는 네이밍 중에서 메소드(함수)에 대해 정리해 보았습니다. 메소드를 작성하기 전 주석을 먼저 작성해 해당 메소드가 무엇을 할지 정의하고 주석을 기반

guruit.tistory.com

 

 

이번 편은 단어에 대해 정리해보겠습니다. 

 

 

A By B

B를 기준으로 A를 하겠다. 

예) moveByCursor

 

 

동사원형

show : 보여주다. 제시하다 (메시지를 제시할 때)

open : 열다. 닫혀 있는 것이 열릴 때. (창을 열 때)

contains : 포함하다

includes : 포함시키다. 

allows : 허용하다

support : 지원하다

accept : 받아준다. 

preserves : 보존하다. 

reset : 정보를 초기값으로 돌림

remove : 특정 영역에서 제거할 때

delete : 완전히 제거하는 것 

compose : 짓다, 조립하다 라는 의미로, 존재하는 것으로부터 재조합하거나 새로운 정보를 만들 때 사용

 

 

반어

get/set  
add/remove 추가/제거
create /destory 창조/파괴
start / stop 시동 /정지 (시간의 흐름)
insert / delete 삽입/삭제
increment / decrement 증가 /감소
old / new 구 /신
begin / end 시작 / 끝

first / last 처음 / 마지막 
up / down 위 / 아래
min / max 최소 / 최대 
next / previous 다음 / 이전
open / close 열다 / 닫다 
show / hide 보이다 / 숨기다. 
suspend / resume 일시정지 / 재개하다. 
parent / child 부모 자식 

Active / Inactive (능동/활성) / (비능동/비활성)

forward / reverse 정방향 / 역방향

 

 

 

fetch

결과를 바로 리턴합니다. 오래 걸리지 않는 동기적 작업이며 요청이 실패하지 않는 종류의 작업입니다. 

 

 

request

비동기 작업으로 handler를 받고 있거나 delegate 콜백으로 결과를 전달해 줍니다. 실패 가능성이 있습니다. 

 

 

register

단순하게 데이터를 등록하는 게 아니라 일련의 작업을 통해 데이터를 등록할 때 사용합니다. 

 

 

boolean 형

is, are, was, were, can, could, may, might, must, shall, will, would 같은 단어로 시작하게 합니다. 

 

 

Make, Create, Generate 

Make는 '만들다, 제작하다'로 재료를 이용해서 만드는 것을 의미하며, 여러 가지 객체를 통해 새로운 객체를 만드는 함수의 이름에 적당합니다. Create는 '창조하다. 무에서 유를 만들다.'로 창작(머릿속에 있는 것을 실체화시키는 것)이나 없는 상태에서 새로운 것을 만드는 느낌으로 데이터베이스에서 데이터를 읽어와 새로운 디자인 객체를 만드는 함수의 이름으로 적당합니다. Generate는 '작성하다, 발생하다, 생성하다.'로 인과적인 관계를 통해 발생되는 것이 적당합니다. 트랜잭션의 한 단계의 이름이 적당합니다. 

 

 

시간

시작시간 : start time

종료시간 : end time

예상종료시간 : estimated end time

현재시각 : current time

경과시간, 소요시간 : elapsed time (현재시각 - 시작시각, 완료 여부와는 무관)

남은시간 : remaining time (예상종료시각-현재시각)

응답시간 : response time

 

시간을 나타낼 때 과거형으로 작성하는 방법도 있습니다. 시작시간을 start time에서 started로 이름 짓는 것이죠. 

 

 

etc.

마지막으로 의미 없는 do, process 등은 사용하지 않는 것이 좋습니다. 메서드를 나타내기 위해 do, process를 사용한다는 것은 메서드의 정의가 애매하는 뜻입니다. 

 

swift(스위프트)에서는 getter에서 인스턴스를 리턴하는 함수의 경우 바로 인스턴스 타입명으로 메서드 명을 짓습니다. 

예) public Data date(string dateFormat)

      public Anchor anchor()

 

 

 

[참고] 변수명 짓는 사이트를 소개해드립니다. 

 

 

Curioustore

변수명 짓기, 컬럼명 짓기, 영어약자, 変数名 つけ方, カラム名建てる, 英語の略語, 命名变量, 命名该列, 英文缩写

www.curioustore.com

 

반응형

댓글