javadoc 평론 비율 기준
계기.
자바doc를 잘 쓰면 댓글 줄의 비율이 높아진다. 목표를 알기 위해 SonarQub3.7.4로 자주 사용하는 프로그램 라이브러리가 어떤지 조사했다.(손 옆에 있는 것은 예전에 만든 것이기 때문에 소나의 버전은 매우 낡았다.)
숫자를 쓰는 것이 귀찮아서 스크린샷을 붙였다.
Guava
Joda-Time
Commons-Collections
Commons-Email
Super CSV
jackson-core
ORM
사용하지 않은 것을 포함하여 OR 매핑도 추가되었습니다.
Ebean
MyBatis
Iciql
Doma
감상
공개 API에 자바doc 리뷰를 붙이는 비율이 높네요.
규모가 작으면 100%, 구아바처럼 큰 것도 90%가 넘는다.
평론률이 모두 20퍼센트를 넘었다.ORM의 조사에 따르면 의외로 낮을 수도 있다.
자바doc 평론의 규약과 프로젝트의 방침에 따라 평론률은 상당히 큰 폭을 보였다.
결론:?
디자인북 등 다른 문서가 있다면 20% 정도 가능합니다.
원본 코드와javadoc만 사용하면 30~40%도 문제없습니다.
공개 API에 모든javadoc 리뷰를 덧붙일지 여부는 하나의 사례죠.
Reference
이 문제에 관하여(javadoc 평론 비율 기준), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다
https://qiita.com/n_slender/items/1bb9412e759617ae5628
텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.
우수한 개발자 콘텐츠 발견에 전념
(Collection and Share based on the CC Protocol.)
Joda-Time
Commons-Collections
Commons-Email
Super CSV
jackson-core
ORM
사용하지 않은 것을 포함하여 OR 매핑도 추가되었습니다.
Ebean
MyBatis
Iciql
Doma
감상
공개 API에 자바doc 리뷰를 붙이는 비율이 높네요.
규모가 작으면 100%, 구아바처럼 큰 것도 90%가 넘는다.
평론률이 모두 20퍼센트를 넘었다.ORM의 조사에 따르면 의외로 낮을 수도 있다.
자바doc 평론의 규약과 프로젝트의 방침에 따라 평론률은 상당히 큰 폭을 보였다.
결론:?
디자인북 등 다른 문서가 있다면 20% 정도 가능합니다.
원본 코드와javadoc만 사용하면 30~40%도 문제없습니다.
공개 API에 모든javadoc 리뷰를 덧붙일지 여부는 하나의 사례죠.
Reference
이 문제에 관하여(javadoc 평론 비율 기준), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다
https://qiita.com/n_slender/items/1bb9412e759617ae5628
텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.
우수한 개발자 콘텐츠 발견에 전념
(Collection and Share based on the CC Protocol.)
Commons-Email
Super CSV
jackson-core
ORM
사용하지 않은 것을 포함하여 OR 매핑도 추가되었습니다.
Ebean
MyBatis
Iciql
Doma
감상
공개 API에 자바doc 리뷰를 붙이는 비율이 높네요.
규모가 작으면 100%, 구아바처럼 큰 것도 90%가 넘는다.
평론률이 모두 20퍼센트를 넘었다.ORM의 조사에 따르면 의외로 낮을 수도 있다.
자바doc 평론의 규약과 프로젝트의 방침에 따라 평론률은 상당히 큰 폭을 보였다.
결론:?
디자인북 등 다른 문서가 있다면 20% 정도 가능합니다.
원본 코드와javadoc만 사용하면 30~40%도 문제없습니다.
공개 API에 모든javadoc 리뷰를 덧붙일지 여부는 하나의 사례죠.
Reference
이 문제에 관하여(javadoc 평론 비율 기준), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다
https://qiita.com/n_slender/items/1bb9412e759617ae5628
텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.
우수한 개발자 콘텐츠 발견에 전념
(Collection and Share based on the CC Protocol.)
jackson-core
ORM
사용하지 않은 것을 포함하여 OR 매핑도 추가되었습니다.
Ebean
MyBatis
Iciql
Doma
감상
공개 API에 자바doc 리뷰를 붙이는 비율이 높네요.
규모가 작으면 100%, 구아바처럼 큰 것도 90%가 넘는다.
평론률이 모두 20퍼센트를 넘었다.ORM의 조사에 따르면 의외로 낮을 수도 있다.
자바doc 평론의 규약과 프로젝트의 방침에 따라 평론률은 상당히 큰 폭을 보였다.
결론:?
디자인북 등 다른 문서가 있다면 20% 정도 가능합니다.
원본 코드와javadoc만 사용하면 30~40%도 문제없습니다.
공개 API에 모든javadoc 리뷰를 덧붙일지 여부는 하나의 사례죠.
Reference
이 문제에 관하여(javadoc 평론 비율 기준), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다
https://qiita.com/n_slender/items/1bb9412e759617ae5628
텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.
우수한 개발자 콘텐츠 발견에 전념
(Collection and Share based on the CC Protocol.)
사용하지 않은 것을 포함하여 OR 매핑도 추가되었습니다.
Ebean
MyBatis
Iciql
Doma
감상
공개 API에 자바doc 리뷰를 붙이는 비율이 높네요.
규모가 작으면 100%, 구아바처럼 큰 것도 90%가 넘는다.
평론률이 모두 20퍼센트를 넘었다.ORM의 조사에 따르면 의외로 낮을 수도 있다.
자바doc 평론의 규약과 프로젝트의 방침에 따라 평론률은 상당히 큰 폭을 보였다.
결론:?
디자인북 등 다른 문서가 있다면 20% 정도 가능합니다.
원본 코드와javadoc만 사용하면 30~40%도 문제없습니다.
공개 API에 모든javadoc 리뷰를 덧붙일지 여부는 하나의 사례죠.
Reference
이 문제에 관하여(javadoc 평론 비율 기준), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다
https://qiita.com/n_slender/items/1bb9412e759617ae5628
텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.
우수한 개발자 콘텐츠 발견에 전념
(Collection and Share based on the CC Protocol.)
디자인북 등 다른 문서가 있다면 20% 정도 가능합니다.
원본 코드와javadoc만 사용하면 30~40%도 문제없습니다.
공개 API에 모든javadoc 리뷰를 덧붙일지 여부는 하나의 사례죠.
Reference
이 문제에 관하여(javadoc 평론 비율 기준), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다 https://qiita.com/n_slender/items/1bb9412e759617ae5628텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.
우수한 개발자 콘텐츠 발견에 전념 (Collection and Share based on the CC Protocol.)