«javadocs» 태그된 질문

최근에 나는 현재 다루고있는 코드베이스의 일부를 리팩토링하는 일을 해왔다. 나 자신을 더 잘 이해하고있을뿐 아니라 코드를 다루는 다른 사람들이 더 쉽게 이해할 수 있도록하기 위해서다. 나는 그 생각의 측면에 의지하는 경향이 자기 문서화 코드가 좋은 것입니다 . 나는 그것이 더 깨끗하다고 ​​생각하고 코드가 스스로를 말하면 글쎄 ... 훌륭 합니다. 반면에 …

18 java  documentation  refactoring  javadocs 

메소드 또는 API가 코드베이스에 있지만 구현이 완료되지 않았거나 변경 될 가능성이 있으므로 사용해서는 안된다는 의미로 "deprecate"와 유사하지만 좋은 용어가 있습니까? (예, 그 방법은 공개되어서는 안됩니다. yada yada yada. 나는 상황을 만들지 않았으며 최선을 다하려고 노력하고 있습니다.) 사람들은 무엇을 제안합니까? 실험적이고 불완전한 다른 것? 여전히 유동적 인이 API에 대한 javadoc 문서를 …

12 documentation  terminology  api  documentation-generation  javadocs 

JavaDoc에서는 다음과 X509Certificate getSubjectDN()같이 말합니다. Denigrated , getSubjectX500Principal ()로 대체되었습니다. 더 이상 사용해서는 안되지만 Denigrated는 사용하지 않는 메소드에 대해 Deprecated가 표시되는 데 익숙합니다. 주석으로 닫히는이 특별한 경우에 대한 버그 보고서를 발견했습니다 . 이것은 버그가 아닙니다. "더 이상 사용되지 않음"은 심각한 경우에만 사용해야합니다. 사용 되지 않는 메소드를 사용하는 경우 일반적인 제안 …

11 java  terminology  javadocs 

잘 알려진 기본 문자열 메트릭의 구현을 제공하는 작은 라이브러리에서 작업하고 있습니다. 대부분 내 자신의 교육을 위해. 약간의 여가 시간이있을 때마다 개발이 이루어집니다. 이로 인해 대부분의 프로세스를 자동화하여 너무 많은 노력을 기울이지 않고도 작업 할 때마다 버전을 릴리스 할 수 있습니다. 그러나 Java doc을 유지하는 것은 예제를 포함하므로 여전히 부담입니다. API가 …

9 java  documentation  javadocs 

DRY 방식으로 Javadoc을 작성하고 싶습니다. 그러나 Javadoc 에 대한 오라클 문서 는 과부하 방법 주석에서 동일한 것을 다시 작성한다고 말합니다. 반복을 피할 수 없습니까?

9 documentation  comments  dry  javadocs