변수명 짓기 질문드립니다.
알림
|
페이지 정보
작성일
2024.05.19 21:10
본문
비개발자로 python을 사용한 flask 서버를 만들어 사용중입니다.
처음에 무턱대고 만들었을 때는 몰랐는데 유지보수와 기능확장을 하다보니 변수명 때문에 리딩이 많이 어려워지네요;
혹시 변수명을 지을때 규칙이 있을까요? 아니면 추천하는 방법이나 규칙이 있는지 궁금합니다.
또 DB 테이블명이나 컬럼명을 지을때 규칙이나 추천하는 방법이 있을련지요?
댓글 5
January4th님의 댓글
https://www.curioustore.com/#!/
위와 같이 변수명 짓는데 도움을 주는 사이트도 있구요, 요즘엔 gpt도 잘 지어주는 편입니다.
단어의 복합은
oneTwoThree 같은 카멜케이스
OneTwoThree 같은 파스칼 케이스
one_two_three 같은 스네이크 케이스가 주로 사용 되는데,
뭘 쓰는지는 쓰는 사람 마음이고, 예외적으로 파스칼 케이스는 대부분 클래스나 타입 선언에 사용하는 경향이 있습니다.
추상화라는 개념도 들어가긴 하는데 이를테면
isSame, isCorrect 같은 판단형 이름이나
filteredValue, calcResult 같은 결과형
valueMatch, arrayMapping 같은 동작형(주로 함수)
같이 알아보기 쉽도록 지어주는 게 좋습니다.
추가적으로 변수 명도 변수 명이지만 적절한 주석과 문서화가 더 크게 도움이 될 겁니다.
위와 같이 변수명 짓는데 도움을 주는 사이트도 있구요, 요즘엔 gpt도 잘 지어주는 편입니다.
단어의 복합은
oneTwoThree 같은 카멜케이스
OneTwoThree 같은 파스칼 케이스
one_two_three 같은 스네이크 케이스가 주로 사용 되는데,
뭘 쓰는지는 쓰는 사람 마음이고, 예외적으로 파스칼 케이스는 대부분 클래스나 타입 선언에 사용하는 경향이 있습니다.
추상화라는 개념도 들어가긴 하는데 이를테면
isSame, isCorrect 같은 판단형 이름이나
filteredValue, calcResult 같은 결과형
valueMatch, arrayMapping 같은 동작형(주로 함수)
같이 알아보기 쉽도록 지어주는 게 좋습니다.
추가적으로 변수 명도 변수 명이지만 적절한 주석과 문서화가 더 크게 도움이 될 겁니다.
에헤라디야님의 댓글
저는 이렇게 합니다.
1.만들고자 하는 기능을 쭉 문장으로 서술한다.
2.문장안에서 명사는 변수명, 동사는 함수명
1.만들고자 하는 기능을 쭉 문장으로 서술한다.
2.문장안에서 명사는 변수명, 동사는 함수명
시리니님의 댓글
저는 약간 쓰다보니 주로 3개의 단어로 조합해서 변수명이나 함수명을 짓는게 보기에도 좋고 이해하기도 더 편하더라구요. 예를 들어 사용자 정보를 가져올 때 그냥 getUser() 해도 사실 크게 상관 없겠지만 getUserInfo() 처럼 한다던지, 미리 데이터베이스에서 게시글 목록을 불러올때 loadPosts() 해도 되지만 loadPostData() 처럼요. 물론 판단형 같은 경우도 뭔가 이름이 괜찮으면 isSameOrigin 처럼 하기도 합니다. 너무 길면 쓰다가 지치고, 너무 짧으면 작성한 나도 까먹으니 약간 규칙처럼 3단어 조합으로 하는 것 같습니다. ㅎㅎ
damoim님의 댓글
Python 에 한해서는 pep-8이라고 네이밍 컨벤션을 포함한 넓은 범위의 가이드라인(?)이 있습니다.
https://www.w3schools.com/python/python_variables_names.asp