[FE] 변수명 함수명 정하는 기준 - Moadong/moadong GitHub Wiki
함수의 동작을 나타내는 데 동사, 객체나 상태를 표현할때는 명사와 형용사 사용
1. 행동을 나타내는 동사 (함수 이름에 유용)
함수나 메서드는 특정 동작을 수행하므로, 동사를 사용해 행동을 명확하게 나타낼 수 있습니다.
- get: 값을 가져오다. 예:
getUserName() - set: 값을 설정하다. 예:
setUserAge() - update: 값을 갱신하다. 예:
updateProfile() - fetch: 데이터를 외부에서 가져오다. 예:
fetchData() - calculate: 계산하다. 예:
calculateTotal() - create: 새로운 무언가를 만들다. 예:
createUser() - delete: 데이터를 삭제하다. 예:
deleteAccount() - add: 요소를 추가하다. 예:
addItem() - remove: 요소를 제거하다. 예:
removeItem() - validate: 유효성 검사를 하다. 예:
validateInput() - check: 확인하다. 예:
checkPermission() - send: 데이터를 전송하다. 예:
sendRequest() - load: 데이터를 로드하다. 예:
loadPage() - save: 데이터를 저장하다. 예:
saveDocument() - render: 화면에 표시하다. 예:
renderPage() - process: 처리하다. 예:
processOrder() - initialize (init): 초기화하다. 예:
initializeApp()또는initApp()
2. 상태를 나타내는 형용사 (변수, 상태 이름에 유용)
상태나 특성을 설명하는 형용사는 변수나 상수의 특성을 명확하게 합니다.
- is: 불리언 변수를 표현할 때 자주 사용됨. 예:
isValid,isActive - has: 상태를 표현하는 변수에 사용. 예:
hasPermission,hasError - can: 가능한지 여부를 나타낼 때. 예:
canSubmit,canEdit - should: 특정 조건을 만족해야 할 때. 예:
shouldUpdate,shouldSave - current: 현재 상태를 나타낼 때. 예:
currentPage,currentUser - previous: 이전 상태를 나타낼 때. 예:
previousValue,previousPage - next: 다음 상태를 나타낼 때. 예:
nextItem,nextStep - max: 최대값을 나타낼 때. 예:
maxLength,maxValue - min: 최소값을 나타낼 때. 예:
minAge,minValue
3. 기타 자주 쓰이는 명사 (데이터나 개체 이름에 유용)
변수나 개체의 데이터 유형을 나타내는 명사는 변수나 함수가 어떤 데이터를 다루는지 명확하게 해줍니다.
- data: 데이터. 예:
userData,productData - info: 정보. 예:
contactInfo,profileInfo - list: 목록. 예:
userList,taskList - item: 항목. 예:
menuItem,cartItem - value: 값. 예:
inputValue,currentValue - result: 결과. 예:
queryResult,operationResult - error: 오류. 예:
validationError,connectionError - message: 메시지. 예:
errorMessage,successMessage - count: 개수. 예:
userCount,itemCount - index: 인덱스. 예:
currentIndex,pageIndex - key: 키 값. 예:
primaryKey,encryptionKey - type: 타입. 예:
userType,responseType - status: 상태. 예:
responseStatus,orderStatus - config: 설정. 예:
appConfig,serverConfig - token: 인증이나 보안 토큰. 예:
authToken,sessionToken
4. 일반적인 프로그래밍 용어
- callback: 콜백 함수. 예:
fetchDataCallback() - handler: 이벤트 처리 함수. 예:
clickHandler(),submitHandler() - service: 서비스 관련 함수나 객체. 예:
emailService,paymentService - component: 컴포넌트(React 등에서 사용). 예:
HeaderComponent,FooterComponent - controller: MVC 패턴에서 컨트롤러 역할. 예:
userController,orderController - model: 데이터 모델. 예:
userModel,productModel
5. 상수와 플래그
상수나 불리언 값을 나타낼 때는 명확한 의미를 가진 상수 이름을 사용하는 것이 좋습니다.
- DEFAULT: 기본값을 나타낼 때. 예:
DEFAULT_TIMEOUT,DEFAULT_LANGUAGE - MAX: 최대값을 나타낼 때. 예:
MAX_USERS,MAX_ITEMS - MIN: 최소값을 나타낼 때. 예:
MIN_AGE,MIN_SALARY - SUCCESS: 성공 플래그. 예:
LOGIN_SUCCESS,SAVE_SUCCESS - FAILURE: 실패 플래그. 예:
LOGIN_FAILURE,SAVE_FAILURE