커피 브레이크 #86. IntelliJ IDEA에서 코드 형식을 다시 지정하는 빠르고 쉬운 가이드

출처: Lightrun 개발자로서 코드베이스를 변경해야 합니다. 그리고 코드 베이스의 형식이 명확하지 않으면 디버깅이 훨씬 더 어려워집니다. 코드의 형식 변경 및 적절한 들여쓰기와 같은 작은 변경 사항은 일반적으로 간과되지만 전문 개발자의 코드베이스와 초보자의 코드베이스를 구별하는 데 분명히 도움이 됩니다. 적절한 코드 형식과 들여쓰기를 유지하면 읽기 쉬운 코드를 작성하는 데 도움이 됩니다. 이를 통해 프로젝트 공동 작업이 단순화되고 디버깅 속도가 향상되며 코드 베이스 유지 관리가 가능해집니다. 코드가 더 읽기 쉽고 구조화됩니다. 코드 재포맷 프로세스의 속도를 높일 수 있습니까? 이 문서에서는 IntelliJ IDEA를 사용하여 자동으로 코드 형식을 다시 지정하는 간단한 방법을 소개합니다. 이 절차에 필요한 시간을 줄이는 방법과 다양한 키보드 단축키를 사용하여 코드베이스의 일부를 다시 포맷하지 않도록 제외하는 방법도 알아봅니다.

재포맷의 이점

함수가 작동하는 데에는 형식 지정이나 주석 달기 코드가 필요하지 않다는 점을 기억하는 것이 중요합니다. 형식 지정 여부에 관계없이 모든 코드는 컴파일러에서 완전히 읽고 실행할 수 있습니다. 반면에 서식을 다시 지정하면 사람들이 마크업을 훨씬 쉽게 읽을 수 있습니다. 컴파일러에게 중요한 것은 코드가 작동하고 오류가 없는지, 코드가 얼마나 좋은지, 들여쓰기가 얼마나 잘되었는지가 아닙니다. 사실, 사람들이 그러한 코드를 읽어야 하기 때문에 걱정하는 것은 후자입니다. 일반 텍스트와 마찬가지로 제목, 단락 또는 들여쓰기 없이 형식 없는 콘텐츠를 읽는 것을 좋아하는 사람은 없습니다. 필요한 재포맷 기술 중 일부는 다음과 같습니다.

• 톱니 모양.
• 스타일 및 쓰기 기능.
• 빈 공간.
• 대문자와 이름을 사용합니다.

디버깅은 개발자가 경력 전반에 걸쳐 자주 직면하게 되는 필요악입니다. 코드베이스가 복잡하고 체계적이지 않다면 어디서부터 시작해야 할까요? 소스 코드의 형식이 적절하고 들여쓰기가 되어 있으면 덜 클러스터된 것처럼 보입니다. 이렇게 하면 다양한 애플리케이션 모듈의 위치를 ​​더 쉽게 확인할 수 있습니다. 결과적으로 문제와 오류를 찾는 것이 더 쉬워집니다. IntelliJ IDEA의 코드 형식 재지정은 IDE의 코드 스타일 설정에 지정된 요구 사항을 기반으로 합니다. 하지만 프로젝트에서 EditorConfig를 사용하면 .editorconfig 파일에 지정한 설정이 기본적으로 코드 스타일 설정에 지정된 설정보다 우선 적용됩니다. IntelliJ에서 다시 포맷하는 것은 다른 IDE에서 작업하는 것과 다르지 않습니다. 단일 코드 블록과 전체 파일을 모두 다시 포맷하는 옵션이 있습니다. 전체 코드 블록이 꽤 길어서 몇 가지 특정 영역을 제외하고 모든 코드의 형식을 다시 지정하고 싶은 경우가 있을 수 있습니다. 이 경우 형식을 지정하려는 코드 부분을 개별적으로 선택하는 것이 최선의 선택은 아닙니다. 이러한 상황에서는 IntelliJ로 다시 포맷하는 것이 확실히 도움이 될 것입니다. 우리는 이것과 IDE의 다른 용도를 탐구할 것입니다.

코드 형식 지정에 대한 팁

일반적인 코드 형식 지정에 대한 몇 가지 기본 팁을 살펴보겠습니다.

• 코드에 올바르게 주석이 달렸는지 확인하세요. 댓글을 사용하여 의도와 의미를 전달하세요. 이 코드를 혼자 읽는 사람이라도 특정 코드 블록의 목적을 상기해 보는 것은 여전히 ​​유용합니다. 예를 들어 휴가 후에 코드베이스로 돌아오면 작업이 더 쉬워집니다.

• 같은 줄에 있는 공백에는 탭을 사용하지 마세요. 이로 인해 코드의 가독성이 떨어집니다.

• 향후 구현을 추적하려면 코드 블록에 TODO를 추가하세요. 이렇게 하면 코드 형식을 다시 지정할 때 작업이 완료되었다는 착각이 들지 않습니다.

• 구문 오류에 대한 빠른 수정으로 코드 재형식화를 사용하지 마십시오.

• 깊은 투자를 피하십시오. 이는 일부 개발자들 사이에서 일반적인 관행이지만 깊게 중첩된 코드로 인해 읽기가 어렵고 언뜻 보기에 쉽지 않은 오류가 발생합니다.

IntelliJ IDEA에서 코드 형식 재지정

IntelliJ에서 코드 형식을 지정하는 다양한 방법을 살펴보기 전에 IDE에서 샘플 Java 프로젝트를 만드는 것부터 시작하세요. IntelliJ를 시작하면 다음과 같은 화면이 표시됩니다. Next를 클릭 하고 프로젝트 초기화 설정을 완료합니다. 이제 프로젝트가 설정되었으므로 IntelliJ의 코드 형식 변경을 이해하는 데 도움이 되는 샘플 코드를 추가할 차례입니다. 이것은 University of Texas의 간단한 단어 카운터 입니다.

import java.io.File;
import java.io.IOException;
import java.util.Map;
import java.util.Scanner;
import java.util.TreeMap;

public class SimpleWordCounter {

    public static void main(String[] args) {
        try {
            File f = new File("ciaFactBook2008.txt");
            Scanner sc;
            sc = new Scanner(f);
            // sc.useDelimiter("[^a-zA-Z']+");
            Map<String, Integer> wordCount = new TreeMap<String, Integer>();
            while(sc.hasNext()) {
                String word = sc.next();
                if(!wordCount.containsKey(word))
                    wordCount.put(word, 1);
                else
                    wordCount.put(word, wordCount.get(word) + 1);
            }

            // show results
            for(String word : wordCount.keySet())
                System.out.println(word + " " + wordCount.get(word));
            System.out.println(wordCount.size());
        }
        catch(IOException e) {
            System.out.println("Unable to read from file.");
        }
    }
}

코드 조각 다시 포맷하기

코드 조각의 형식을 지정하는 것부터 시작해 보겠습니다. 이렇게 하려면 서식을 지정하려는 코드 부분을 강조 표시하고 Code > Reformat Code 를 클릭하면 됩니다 . 보시다시피 코드에서 강조 표시된 부분(이 경우 11-17행)의 형식이 올바르게 지정되었습니다. 코드 조각을 다시 포맷하는 "이전"과 "이후"를 살펴보겠습니다. 첫 번째 이미지를 보면 변수의 선언과 초기화가 try 와 같은 줄에서 발생했다는 것을 알 수 있습니다 . 닫는 중괄호는 else 블록과 혼합됩니다 . 그러나 코드의 이 부분을 강조 표시하고 다시 형식 지정 옵션을 사용하면 눈에 더 보기 좋은 코드 블록이 생성됩니다. 이제 클래스의 전체 코드는 다음과 같습니다. 선택한 코드 블록만 다시 형식화되었습니다.

전체 파일 형식 재지정

전체 파일의 형식을 다시 지정하려면 편집기를 열고 아무 곳에나 커서를 놓은 다음 Code >Reformat File을 클릭합니다 . 전체 파일에 대해 적절한 형식 재지정 옵션을 선택하라는 메시지가 표시됩니다. 이 작업을 수행하면 활성 편집기의 모든 코드 형식이 다시 지정됩니다. 귀하의 코드는 다음과 같습니다:

모듈 또는 디렉터리 재포맷

이렇게 하려면 프로젝트 도구 창에서 모듈을 마우스 오른쪽 버튼으로 클릭하고 Reformat Code 를 선택하기만 하면 됩니다 . 팝업 창에서 필요한 세 가지 옵션 중 하나를 선택하십시오.

• 가져오기 최적화 : 누락된 가져오기 문을 추가하고 사용하지 않는 가져오기도 제거하려면 이 옵션을 선택합니다.

• 항목 재정렬 : 코드 스타일 설정에 지정된 레이아웃 규칙에 따라 코드를 재구성합니다.

• 정리 코드 : 코드 정리를 실행합니다.

완료되면 확인을 클릭하면 됩니다.

형식 재지정에서 코드 제외

전체 파일을 포맷할 때 포함하고 싶지 않은 코드 블록이 있는 경우 어떻게 해야 하는지 살펴보겠습니다. 파일 > 설정 으로 이동하거나 키보드 단축키 Ctrl + Alt + S를 사용합니다. 편집기 > 코드 스타일 로 이동하여 포맷터 제어 탭 의 주석 메뉴에서 포맷터 마커 활성화 를 선택합니다 . 편집기에서 라인 주석을 작성하고 제외하려는 영역의 시작 부분에 따옴표 없이 //@formatter:off를 입력하십시오. 영역 끝에 또 다른 줄 주석을 만들고 따옴표 없이 //@formatter:on 을 입력합니다. 위 이미지에서 주석 및 형식 컨트롤러에 코드를 지정했기 때문에 포맷터가 23행의 코드를 무시한다는 것을 알 수 있습니다.

재포맷을 위한 단축키의 예

• 코드 블록 다시 포맷: Ctrl + Alt + Shift + L
• 파일 형식 재지정: Ctrl + Alt + L
• 줄에 주석 추가: Ctrl + /
• 블록 주석 추가: Ctrl + Shift + /

결론

코드 형식에 주의를 기울이는 것은 코드를 작동시키는 것만큼 개발자에게 중요합니다. 누가 당신의 코드 작업을 끝내게 될지 결코 알 수 없습니다. 읽기 쉽고 잘 구조화된 코드 기반은 전문 개발자를 나타냅니다. IntelliJ IDEA를 사용하면 코드 형식을 지정하는 것이 코드 자체를 작성하는 것만큼 어렵지 않습니다. 다음에 IntelliJ를 사용하여 코드를 작성할 때 이 팁을 사용하세요. 이렇게 하면 코드를 디버깅할 때 작업이 더 쉬워집니다.