JSDoc을 작성하는 컨벤션이 있나요?

안녕하세요. 현재 caver-js의 타입스크립트를 작성하는 작업중에 있습니다.

진행하며 KIP 34와 함수 위에 적혀진 JSDoc을 참고하고 있습니다만,
JSDoc에 명시된 타입과 해당 함수가 가지는 타입이 다른 경우가 있습니다.
이를 수정하여 PR하려 하는데 JSDoc으로 작성된 형식이 함수 마다 달라 질문드립니다.

예를 들어, Typescript의 경우 string과 String, Object와 object는 다릅니다.
하지만 JSDoc의 경우 구분하지않고 작성하는 팀의 컨벤션을 따르라는 안내가 있었습니다.

작성된 caver-js의 함수들의 경우 이들이 혼합되어 사용되어 있어 새로 수정하는데 어떤 형식으로 고쳐야 할지 모르겠습니다. 상관없이 제 스타일대로 작성해도 되는 것인가요? :sweat_smile:

1개의 좋아요

안녕하세요.

jsDoc의 타입을 명시할 때는 string과 object를 사용해 주시면 됩니다.
Common Architecture의 경우 언어 관계없이 SDK가 가지는 기본적인 골격이 정의되어 있으나 언어 별 SDK 구현에 따라 타입이 다를 수 있습니다. 참고 부탁드립니다.

감사합니다.

1개의 좋아요