주석중독

 

요즘 style로 이거 쓰는 중

https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml

styleguide/intellij-java-google-style.xml at gh-pages · google/styleguide

 

 

근데 약간의 고증이 있다.

 

tabsize=2라서 불편한건

https://github.com/loom/loom-java/blob/main/.editorconfig

이거랑 동시 적용해서 해결했는데

 

각 메소드/클래스 레벨로 javaDoc 주석을 안달면 무차별 주석 다세요 경고 폭격을 해버린다.

@suppresswarnings로 무시할 순 있으나, 모든 클래스에 달아야하는 불편함이 있기에

그냥  javaDoc 주석 쓰는 방법을 익히기로 했다. (구글 스타일을 쓰니까 구글 소스코드에 써있는 방법을 따라함)

 

기존의 /* ... */ 블럭 대신 /** ... */로 사용할 수 있음

GoogleAuthorizationCodeRequestUrl 소스코드 일부

 

신기하게도 JavaDoc는 HTML 태그나 링크를 걸 수도 있었고, 왼쪽 상단의 책버튼을 누르면 읽기 쉽게 바꿔줌

 

 

 

클래스를 링크하면(단, 먼저 import 되어있어야 함)

마우스 커서 올릴 때 퀵 도큐먼트도 표시해주고(hovering?) 클릭하면 소스 코드로 이동시켜줌

class#...으로 하위 (메서드 등)멤버도 링크 가능

 

<a href=...>로 프로젝트 내 파일도 링크할 수 있음

 

 

쓰고보니 재밌어서  개인 프젝 변수에도 TODO나 인사이트 기록함

 

가독성이 너무 좋아서 홀린듯 쓰다가 찾아보니,

 

javaDoc는 공식 문서화가 목적이므로 이 경우엔 일반적인 주석이나 IDEA내의 기능을 쓰는게 적합하다고 한다.

 

비슷한 이유로 쌩뚱맞은 곳에 적으면 Dangling Javadoc comment라고 지우라고 함 (주석은 안그럼)

 

 

따라서, 이렇게 바꿔줘야 한다. (일종의 예시임: https://sh3542.tistory.com/203)

 

지식이 늘었다.