컨벤션 효과 convention effect

컨벤션 효과 convention effect

최근 작업 구조를 수정하면서 프론트에서 사용할 함수명에 대한 고민이 많았다. 그러다보니 코딩컨벤션이 더 절실해졌고, 어떤 단어를 써야하나 고민하면서 찾아보시면 convert, format. 비슷한 단어들이 정말 많이 출현했다. 그래서 최근 시기 변수나 함수명을 네이밍 할 때 주로 애용하는 ChatGPT에게 물어보고 뜻을 정의한 후, 사용할 naming을 정했다. 일반적으로 한 유형의 데이터를 다른 유형으로 변환하는 데 사용됩니다. 예를 들어, 문자열을 정수로 변환하거나, 날짜를 문자열로 변환하는 등의 작업이 포함될 수 있어요.


줄바꿈 Linewrapping
줄바꿈 Linewrapping

줄바꿈 Linewrapping

줄바꿈은 작성한 명령어가 줄 너비를 초과했을 경우 코드 가독성을 위해서 강제로 줄을 바꾸는 것을 말합니다. 6.1. 최대 줄 너비는 120 linelength120 최대 줄 사용 너비는 120자까지 가능합니다. 6.2. package,import 선언문은 한 줄로 1linepackageimport ackage,import 선언문 중간에서는 줄을 바꾸지 않습니다. 최대 줄수를 초과하더라도 한 줄로 씁니다.

6.3. 줄바꿈 후 추가 들여쓰기 indentationafterlinewrapping 줄바꿈 이후 이어지는 줄에서는 최초 시작한 줄에서보다. 최소한 1단계의 들여쓰기를 더 추가합니다.

들여쓰기 Indentation
들여쓰기 Indentation

들여쓰기 Indentation

들여쓰기는 코드의 계층을 구분하기 위해 추가하는 문자입니다. 4.1. 하드탭 사용 indentationtab 탭tab 문자를 사용하여 들여씁니다. 탭 대신 스페이스를 사용하지 않습니다. 이를 잘 준수하기 위해서 스페이스와 탭을 구별해서 보여주도록 에디터를 설정합니다. 4.2. 탭의 크기는 4개의 스페이스 4spacestab 1개의 탭의 크기는 스페이스 4개와 같도록 에디터에서 설정합니다.

4.3. 블럭 들여쓰기 blockindentation 클래스, 메서드, 제어문 등의 코드 블럭이 생길 때마다. 1단계를 더 들여씁니다.

OS 파일 시스템 차이가 주된 이유다.
OS 파일 시스템 차이가 주된 이유다.

OS 파일 시스템 차이가 주된 이유다.

찾다. 보니 나랑 비슷한 생각을 하고 있는 질문자와 친절히 답변해 준 사람을 발견할 수 있었어요. 질문자는 평소에 가독성을 위해 리눅스에서 파일 이름을 대문자로 사용하고 있습니다. 하지만 주변 사람들은 파일 이름을 다. 소문자로 사용하고 있는 걸 발견했고 찜찜해서 찾아보니 웬만하면 파일 이름은 소문자로 사용하라는 글을 알게 됐습니다. 그게 사실인가?라고 질문했고 답변자는 개발자는 shift 키를 싫어합니다.

대문자 잠금을 없애려는 사람들도 있습니다. 사실 귀찮음보다. 더 필요한 이유는 대소문자로만 구분된 두 파일을 대소문자를 구분하지 않는 시스템으로 전송하는 경우 대소문자를 구분하지 않는 시스템에서 번잡한 일이 발생할 수 있기 때문입니다. 하지만 리눅스 컴퓨터의 파일은 너의 것이고 너의 방식에 맞는 계획을 사용하세요라고 답변했다.

빈 줄 Blank lines

빈 줄은 명령문 그룹의 영역을 표시하기 위하여 사용합니다. 7.1. package 공포 후 빈 줄 삽입 blanklineafterpackage ackage com.naver.lucy.utilimport java.util.Date

7.2. import 선언의 순서와 빈 줄 삽입 importgrouping import 구절은 아래와 같은 차례대로 그룹을 묶어서 선언합니다.

1. static imports2. java.3. javax.4. org.5. net.6. 8~10을 제외한 com.*7. 1~6, 8~10을 제외한 패키지에 있는 클래스8. com.nhncorp.9. com.navercorp.10. com.naver.

각 모임 사이에는 빈줄을 삽입합니다.

같은 모임 내에서는 알파벳 순으로 정렬합니다.

prepare

데이터를 필요한 형식으로 변환하고 정리하는 등의 작업 수행하여 후속 처리를 위해 데이터를 준비합니다. 위와 같이 정의 후, 현재 프로젝트에서 활용하는 naming 들. convert 데이터의 단순 형변환에 사용합니다. 예시 object query key string format 서버 데이터를 프론트의 데이터 형식에 맞게 변환합니다. 예시 api response data table list data repare 프론트에서 사용한 데이터를 서버에 보낼 때 형식에 맞게 변환합니다.

예시 tree data api request data helper format이나 prepare 함수가 너무 길어져 알아보기 어려울 때, 해당 함수를 쪼개어 보조함수로 사용합니다.

자주 묻는 질문

줄바꿈

줄바꿈은 작성한 명령어가 줄 너비를 초과했을 경우 코드 가독성을 위해서 강제로 줄을 바꾸는 것을 말합니다. 궁금한 사항은 본문을 참고하시기 바랍니다.

들여쓰기

들여쓰기는 코드의 계층을 구분하기 위해 추가하는 문자입니다. 자세한 내용은 본문을 참고하세요.

OS 파일 시스템 차이가 주된

찾다 좀 더 자세한 사항은 본문을 참고하시기 바랍니다.