Clean Code - 주석 어떻게 사용하고 있나요?

개발을 하다 보면 추후에 유지보수 또는 다른 사람에게 소스를 보여줄 때 등

코드 주석이 필요한 경우가 있습니다.  🧑‍💻🧑‍💻🧑‍💻

(물론 주석이 조차 필요 없는 깔끔하고 예쁜 소스가 가장 좋지만요...)

 

 

---

 

혹시 주석 어떻게 사용하고 있나요??  👀

 

자 유저의 코드 정보를 받아서 유저 이름으로 변환해주는 메서드가 있다고 상상해봅시다.

이 메서드가 어떤 역할을 하는지 간단한 주석을 남기려고 합니다.

 

// 유저 코드를 가지고 유저 이름 반환 해주는 메서드 
    private fun getUserName(code: Int): String {
        return when(code){
            0 -> "Rachel Greene"
            1 -> "Monica Galler"
            2 -> "Phoebe Buffay"
            3 -> "Joey Tribbiani"
            4 -> "Chandler Bing"
            5 -> "Ross Geller"
            else -> ""
        }
    }

 

위와 같이 // 를 이용하여 주석을 남길 수도 있지만,

BUT 

/** */ 를 이용하여 주석을 남겨보겠습니다.

 

/** 유저 코드를 가지고 유저 이름 반환 해주는 메서드 */
    private fun getUserName(code: Int): String {

 

 

이렇게 주석을 남기면 뭔가 엄청난 개발자가 작성한 메서드처럼

메서드에 마우스를 올리면 주석 내용이 노출됩니다.

 

 

 

---

 

위와 같은 기능을 JSDoc이라고 하며

요즘 대부분의 에디터들은 JSDoc 기능을 지원하고 있습니다.

 

Use JSDoc: Index

 

---

 

자 그럼 조금 더 알아보도록 하겠습니다.   💁‍♂️💁‍♂️

 

/**
 * @param code 유저 코드
 * @return 유저 이름
 */
private fun getUserName(code: Int): String {

 

 

 

@parm, @return 을 이용하여 

파라미터와 리턴 값의 설명을 추가할 수 있습니다.

 

---

 

/**
 * @throws FileNotFoundException 지정된 파일을 찾을 수 없습니다
 *
 */
private fun getUserName(code: Int): String {
   return when(code){
       0 -> throw FileNotFoundException("FileNotFoundException")
       ...

 

 

@throws 를 이용하여 예외상황을 미리 알려줄 수 있습니다.

 

 

앞으로 조금 더 개발자스러운 주석 생성 어떠신가요??

🧑‍💻🧑‍💻🧑‍💻

 

 

---

혹시 이런 글은 어떠신가요??  💁‍♂️💁‍♂️

 

[Android] Android Debug Mode 잘 활용하기 (안드로이드 스튜디오 디버깅)

 

 

---

여기까지 저의 긴 글을 읽어주셔서 감사합니다.

제가 습관적으로 코딩을 하는 그날까지 습관적으로 코딩을 하기 위해 글 작성을 꾸준하게 하겠습니다.