코딩할 때 가장 먼저 생각하는 것은 작성한 코드를 컴퓨터가 처리하는 방법입니다. 그러나 사람들이 당신의 코드를 어떻게 읽을지 생각하는 것도 중요합니다.
팀과 함께 프로젝트를 진행하든, 아니면 스스로 무언가를 구축하든, 코드를 적절하게 문서화하기 위한 조치를 취해야 합니다. 바로 여기에서 주석이 필요합니다.
주석은 컴퓨터에서 무시되는 프로그램에서 작성된 한 줄 또는 여러 줄의 텍스트입니다. 주석은 자신이든 다른 사람이든 당신의 코드를 읽고 있는 사람에게 프로그램의 의도를 설명하는 데 사용됩니다.
이 튜토리얼에서는 Java로 주석을 작성하는 방법에 대해 설명하고 효과적인 주석을 작성하는 데 사용할 수 있는 몇 가지 모범 사례를 살펴봅니다.
자바 주석
프로그래밍이 처음이라면 다음과 같이 자문할 수 있습니다. 코드에 주석을 달아야 하는 이유는 무엇입니까? 코드 주석을 작성하는 것이 중요한 몇 가지 이유가 있습니다.
코드를 작성할 때 누군가가 귀하의 코드를 읽을 수 있음을 인정하는 것이 중요합니다. 또한, 귀하의 코드를 읽는 사람이 귀하가 작성한 코드를 이해할 것이라는 보장도 없습니다.
혼자 작업하는 경우 주석이 없는 코드가 있으면 답답하고 코드 작동 방식을 파악하는 데 시간을 할애할 수 있습니다. 하지만 팀에서 일하고 있다면 코멘트가 없는 것이 훨씬 더 혼란스러울 수 있습니다. 다른 개발자가 귀하의 코드에 대해 질문해야 할 수 있으며 이는 귀중한 시간을 소비할 수 있습니다.
전반적으로 주석을 작성하면 코드를 더 쉽게 읽을 수 있습니다. 복잡한 절차를 작성할 때 코드 옆에 특정 코드 줄 뒤에 숨은 의도를 설명하는 일반 텍스트가 있으면 도움이 될 수 있습니다. 귀하가 작성하는 주석은 특히 프로젝트에서 다른 개발자와 함께 작업하는 경우 나중에 참조하는 데 유용합니다.
참가자의 81%는 부트캠프에 참석한 후 기술 직업 전망에 대해 더 자신감을 느꼈다고 말했습니다. 지금 부트캠프에 참여하십시오.
부트캠프 졸업생은 부트캠프 시작부터 첫 직장을 찾는 데까지 6개월도 채 걸리지 않았습니다.
최고의 주석은 코드 이면의 의도를 설명합니다. 한 줄의 코드가 수행하는 작업을 반복하지 않고 특정 방식으로 작업을 수행한 이유는 무엇입니까? 효과적인 댓글은 질문에 답하고 효율성을 높입니다.
자바 주석 구문
Java에서 작성할 수 있는 문서 주석에는 한 줄 주석과 여러 줄 주석의 두 가지 유형이 있습니다.
한 줄 주석
인라인 주석이라고도 하는 한 줄 주석은 코드 줄 끝에 나타납니다.
인라인 주석은 일반적으로 한 줄 정도 지속되는 코드의 작은 부분에 주석을 다는 데 사용됩니다.
It’s Friday라는 메시지를 출력하는 프로그램을 작성한다고 가정해 봅시다. 콘솔에. 코드를 추적하기 위해 주석을 작성하고 싶습니다. 다음은 사용할 수 있는 인라인 주석의 예입니다.
public class FridayMessage {
public static void main(String[] args) {
System.out.println("It's Friday!"); // prints "It's Friday" to the console
}
}
인라인 주석은 특정 코드 줄 뒤에 있는 의도를 설명해야 할 때만 사용해야 합니다. 많은 수의 인라인 주석이 포함된 코드는 빠르게 읽기 어려워질 수 있습니다.
주석을 작성할 때 주석 뒤에 숨겨진 의도를 설명하는 것이 목표여야 한다는 점에 유의하는 것이 중요합니다. 위의 예에서 우리의 주석은 우리 코드가 무엇을 하는지 알기 쉽기 때문에 별로 유용하지 않았습니다. 그러나 더 복잡한 코드 행이 있는 경우 주석이 필요할 수 있습니다.
여러 줄 주석
블록 주석이라고도 하는 여러 줄 주석은 코드 섹션을 설명하는 데 사용되는 주석입니다. 여러 줄 주석은 여러 줄로 지속되며 일반적으로 파일 상단이나 코드 블록이 시작되기 전에 배치됩니다.
여러 줄 주석은 /*로 시작합니다. */로 끝남 . 다음은 Java 소스 파일에 있는 여러 줄 주석의 예입니다.
/* 여러 줄 주석의 예입니다.
아래 코드는 It’s Friday!를 출력합니다. 콘솔에.
*/
public class FridayMessage {
public static void main(String[[ args) {
System.out.println("It's Friday!");
}
}
이 예에서 주석은 코드의 처음 세 줄에 나타납니다.
종종 여러 줄 주석은 파일 자체에 대한 세부 정보를 기록하기 위해 파일 시작 부분에 사용됩니다. 예를 들어 여러 줄 주석에는 파일 작성자, 파일 버전 및 유사한 정보가 포함될 수 있습니다.
테스트용 코드 주석
문서화 방법으로 사용되는 것 외에도 주석은 소프트웨어 개발의 테스트 및 디버깅 단계에서 코드가 실행되는 것을 방지하는 데에도 사용됩니다. 코더는 이것을 commenting out code.라고 합니다.
예외를 발생시킨 프로그램을 작성하고 있다고 가정합니다. 아직 무엇이 잘못되었는지 잘 모르기 때문에 문제의 원인을 파악하는 데 도움이 되도록 코드의 일부를 주석 처리하려고 합니다. 다음은 한 줄의 코드를 주석 처리하는 데 사용되는 주석의 예입니다.
class FridayMessage {
public static void main(String[[ args) {
String day_of_the_week = "Friday";
// System.out.println("It's " ++ day_of_the_week);
}
}
이 예에서는 System.out.println으로 시작하는 코드 줄을 주석 처리했습니다. . 우리 코드는 오류를 반환했으며(하나 대신 두 개의 ++를 사용했기 때문에) 오류의 원인을 파악하는 동안 코드를 주석 처리했습니다.
코드를 주석 처리하는 것은 프로그램의 논리를 분석할 때 특히 유용할 수 있습니다. 이러한 상황에서 가장 효율적인 코드를 찾을 때까지 코드의 여러 반복을 주석 처리할 수 있습니다. 그 이후에는 이전 코드를 제거할 수 있습니다.
테스트 및 디버깅 단계에서만 코드를 주석 처리해야 합니다. 최종 프로그램에 주석 처리된 코드를 남겨두는 것은 다른 개발자에게 혼란을 줄 수 있고 또한 코드를 읽기 더 어렵게 만듭니다.
결론
Java에는 두 가지 유형의 주석이 있습니다. 한 줄(또는 인라인) 주석과 여러 줄(또는 블록) 주석입니다. 이러한 주석은 코드를 문서화하는 데 사용되며 소프트웨어 개발의 테스트 및 디버깅 단계에서 도움이 될 수도 있습니다.
시간을 내어 코드에 주석을 달면 자신과 코드를 읽을 수 있는 다른 사람 모두가 작업을 더 쉽게 읽을 수 있습니다. 마지막으로, 최고의 주석은 코드 이면의 의도를 설명하는 주석이라는 것을 기억하십시오.
이제 전문가처럼 Java로 댓글을 작성할 준비가 되었습니다!