[Chore] KDoc 을 활용하여 주석 남기기

[JeonK1]

[제안 2/6]

✨ 설명

코드마다 적절하게 클래스/함수에 대한 적절한 설명이 인상적입니다
안쓰는 사람도 있지만, 최신 코틀린 라이브러리의 내부 코드를 살펴보면 많은 상황에서 주석 작성을 위해 KDoc 문법을 활용하여 남기곤 합니다.
LinkU 팀에도 이를 활용하면 주석을 조금 더 정형화된 규칙으로 효과적으로 남기실 수 있을 수 있어보여 추천드립니다.

KDoc 에 대한 코틀린 공식문서 링크를 공유드립니다

• https://kotlinlang.org/docs/kotlin-doc.html#block-tags

그리고 KDoc 을 적용할 때의 실사례는 아래와 같습니다.

// Before 
/*
* 링큐의 바텀 내비게이션 바
* */
@Composable
fun LinkuNavigationBar(
    /*
    * currentLinkuNavigationItem: 현재 선택된 아이템 및 보이는 화면의 이름
    * onNavigate: 아이템 클릭 시 호출되는 콜백
    * onFABClick: 링크 추가 버튼 클릭 시 호출되는 콜백
    * */
    currentLinkuNavigationItem: LinkuNavigationItem?,
    onNavigate: (LinkuNavigationItem) -> Unit,
    onFABClick: () -> Unit,
) {

// After
/**
 * 링큐의 바텀 내비게이션 바
 * @param currentLinkuNavigationItem 현재 선택된 아이템 및 보이는 화면의 이름
 * @param onNavigate 아이템 클릭 시 호출되는 콜백
 * @param onFABClick 링크 추가 버튼 클릭 시 호출되는 콜백
 */
@Composable
fun LinkuNavigationBar(
    currentLinkuNavigationItem: LinkuNavigationItem?,
    onNavigate: (LinkuNavigationItem) -> Unit,
    onFABClick: () -> Unit,
) {

호출부	구현부

여담이지만 이렇게 KDoc 문법으로 주석을 남기면 위와 같이 IDE 상에서 함수에 마우스를 올렸을 때 주석으로 작성한 내용이 제공되기도 합니다.

📌 해야 할 일

• 클래스/함수에 대한 주석을 KDoc 문법으로 전환

📆 기한

무기한