댓글 작성 방법

댓글은 모든 프로그램에서 가장 과소평가된 부분이지만 개발 프로세스가 진행되는 방식에 중요한 역할을 할 수 있습니다. 컴파일러나 인터프리터가 주석을 무시하더라도 개발자로서 주석 작성을 무시할 이유가 없습니다.

그러나 주석을 작성해야 한다고 해서 전체 코드에 단일 주석을 넣거나 각 줄에 주석을 쓰는 것은 아닙니다. 동료 개발자나 미래에 코드를 더 잘 유지 관리하는 데 도움이 되는 몇 가지 모범 사례를 따라야 합니다.

1. 댓글이 아닌 의미 있는 이름을 쓰세요

함수, 변수, 객체 등에 대한 좋은 명명 규칙을 따르십시오. 어떤 종류의 값 변수가 저장되는지 언급하기 위해 주석을 작성할 필요가 없습니다.

이렇게 하는 대신

function Funtion1(r) {
    // this function returns the area of a circle
    // r is the radius of the circle
    return 3.1416 * r * r;   
}

당신은 이것을 할 수 있습니다

function CircleArea(radius) {
    return Math.Pi * Math.Pow(radius, 2)
}

보시다시피, 좋은 명명 방법은 2줄의 주석을 저장했습니다.

2. 간단하게, 짧게 유지

결국 주석의 유일한 목적은 코드를 더 읽기 쉽게 만드는 것이지 기여하려는 개발자를 혼란스럽게 하지 않는 것입니다. 가능한 한 간단하게 유지하십시오. 문법 오류를 수정하려고 하기보다 키워드에 집중하십시오. 결국, 당신은 소설이 아니라 코드를 작성하고 있습니다.

function SyntaxHighlighter(code) {
    // this function first takes the code as input then highlights the keywords in the code by wraping with <span>. After that it returns it.
    ...
}

function SyntaxHighlighter(code) {
    // returns the syntax highlighted code
}

함수 이름이 목적을 꽤 잘 설명하므로 두 번째 코드에 주석을 넣을 필요가 전혀 없었지만 요점은 알았습니다. 😋

또한 항상 기억하십시오. 코드를 문서화하는 것이 아니라 주석을 작성하는 것입니다. 예, 여러분 중 일부는 주석 달기가 코드를 문서화하는 것과 비슷하다고 주장할 수 있습니다. 예, 저도 동의합니다. 그러나 이것은 더 큰 그림의 작은 부분일 뿐입니다. 지금은 그냥 하지 마세요.

3. 전기를 추가하지 마십시오

다른 사람들이 코드를 복사하여 붙여넣으면 댓글에 이름이 남아 있을 거라고 생각하면서 사람들이 미쳐가고 댓글에 최대한 많은 정보를 추가하는 코드를 충분히 보았습니다. 🤦‍♂️

나는 그들이 키보드에 Backspace라는 버튼이 있다는 것을 모른다고 생각합니다.

/* 
Author Name: ABCD WXYZ
Date created: 1/2/2011

Language: Javascript, HTML, CSS
Code Editor: Visual Studio Code

Eye Color: Green
Favorite Color: Blue
Favorite Car: Ford Mustang

Father's Name: ASDFGH
Mother's Name: QWERTY
*/

왜?! 왜?!

4. 코드에 어떤 버그가 있는지 언급하지 마십시오.

일반적으로 코드의 특정 부분으로 인해 오류가 발생한다는 것을 알고 있지만 수정 사항이 없습니다. 따라서 코드의 특정 부분이 작동하지 않는다고 주석 처리했습니다.

function MyFunction(something) {
    ... // This code doesn't work because that code does
}

이런 댓글 달아도 문제 없습니다. 그러나 동일한 오류에 다시 직면할 경우 장기적으로 도움이 될 것이므로 버그를 기록해 두는 것이 좋습니다(Github를 사용하는 경우 "문제"사용).

5. 좀비 코드를 피하세요 🧟‍♂️

그러나 좀비 코드는 무엇입니까? 🤨

글쎄, 나는 "좀비 코드"가 프로그래밍의 실제 용어인지조차 모른다. 이 블로그를 쓰면서 막 생각해 냈습니다. 다음은 예입니다.

// function CircleArea(radius) {
//     return Math.Pi * Math.Pow(radius, 2)
// }

말이된다? 보시다시피 이것은 기능적인 코드이지만 비활성화되어 있습니다. 앞에서 언급했듯이 일종의 버전 제어 시스템을 사용하는 경우 지금 필요하지 않다고 생각되면 코드의 일부를 주석 처리할 필요가 없지만 나중에 유용할 수 있습니다. 그냥 삭제하고 버전 제어 시스템이 나머지를 처리하도록 하십시오.


그래, 오늘은 이 말을 해야 했다. 댓글을 작성할 때 따라야 하는 관행을 알려주세요.

온라인 수업을 듣다가 심심해서 다 썼어요. 😋 여기에서 뭔가 잘못된 부분이 보이면 용서해주세요 😋