유지보수 Java 주석?

Question

내 프로 천천히 구현 Java 할 수 있습니다.절반의 개발자는 자신을 포함-찾아서는 아무것도 하는 복잡한 특수효과를 추가하는 것 같이 우리의 전반적인 유지보수 부담이 있습니다.의 나머지 절반은 팀은 생각들은 꿀벌의 무릎.

What's 의 실제 경험으로 팀이 개발자를 유지 할 수있는 주석 코드?

Answer 1

나는 그것을 느끼를 사용하여 주석-주석을 제공하는'설명'클래스의 대주석을 제공하의 의존'의 클래스입니다.

난 괜찮아 가진'설명의 주석에서 클래스-평화 속에서 클래스고에 주석 도움을 줄임 버전의 것-JPA 주석에서 떨어이다.

그러나 나는 진짜로 좋아하지 않는다는'종속성'주석-당신은 종속성을 바로에서 클래스-는 경우에도 그 결정에서 런타임에는 주석이 아닌 컴파일 시에서 클래스-지 않는 종속성입니다.(아마도 정신에서 오히려 이상에서 규칙을...)

될 수 있 개인의 선호도,그러나 나 아 하나 큰 XML 파일을 포함하는 모든 종속한 정보의 내 응용 프로그램 보이는'응용 프로그램 구성'이 아닌'클래스 configuration'.오히려 검색을 통해 알려진 하나 이상의 위치를 찾을 통해 모든 클래스에서는 앱입니다.

Answer 2

저의 개인적인 경험은 평균적으로 주석을 다루는 것이 대부분의 개발자가 표준 Java XML 구성 지옥을 다루는 것보다 훨씬 쉽다는 것입니다. JPA 및 Spring Testing과 같은 것들의 경우 절대적인 생명의 절차입니다.

주석의 좋은 점은 수업에서 자체 문서화를 구성한다는 것입니다. 이제 거대한 XML 파일을 검색하여 프레임 워크가 클래스를 사용하는 방법을 알아내는 대신 수업 당신에게 말한다.

일반적으로 이와 같은 변화의 문제는 그들에게 익숙해지는 데 시간이 걸린다는 것입니다. 개발자를 포함한 대부분의 사람들은 변화에 저항합니다. 봄과 함께 일을 시작했을 때를 기억합니다. 처음 몇 주 동안 나는 왜 누군가가 그것과 관련된 두통을 참을 수 있는지 궁금해했다. 그리고 몇 주 후, 나는 내가 그것없이 어떻게 살았는지 궁금했다.

Answer 3

나는 절대적으로 사랑 주석. 나는 Hibernate/JPA, Seam, Jaxb에서 사용합니다 .... 내가 할 수있는 모든 것. IMO 클래스가 어떻게 처리되는지 알아 내기 위해 XML 파일을 열어야하는 것보다 더 나쁜 것은 없습니다.

내 눈에 주석을 달면 수업이 스스로 말할 수 있습니다. 또한 주석은 IDES 컨텐츠 어시스트의 (희망적으로) 일부이며 XML 구성을 사용하면 일반적으로 혼자입니다.

그러나 XML 구성 및 주석이 실제로 특정 라이브러리에서 실제로 사용되는 방식 (대부분은 모두 제공)과 어떤 종류의 주석이 사용되는지에 달려있을 수 있습니다. XML 구성에 따라 빌드 별 (예 : 파일/URL 경로)을 정의하는 주석이 실제로 더 쉬울 수 있다고 상상할 수 있습니다.

Answer 4

IDE 지원에 크게 의존합니다. 나는 주석이 IDE의 수표를 통해 코드와 동기화되어야한다고 생각하지만, 이에 대한 지원은 다소 부족하다.

예를 들어 @override없이 함수를 무효화 할 경우 이전 버전의 아이디어가 경고하지만 메소드 서명 (또는 그 문제에 대한 슈퍼 클래스 서명)을 변경하고 관계를 어기는 경우 @override 태그를 제거하지 않습니다.

지원 없이는 코드에 메타 데이터를 추가하는 번거로운 방법을 찾습니다.

Answer 5

나는 당신이 언급 한 특정 사용 사례 (자동 생성 웹 양식)가 주석의 훌륭한 사용 사례라고 개인적으로 생각합니다. 단순화 된 코드를 작성하고 프레임 워크가 몇 가지 제안 (일명 주석)을 기반으로 무거운 (종종 반복적 인) 리프팅을하도록 할 수있는 모든 종류의 "프레임 워크"시나리오는 주석의 이상적인 사용 사례라고 생각합니다.

나는 당신이 왜 궁금합니다 ~하지 않다 이 상황에서 주석처럼, "유지 보수 부담"이라고 생각하는 것은 무엇입니까? (그리고 나는 당신의 입장을 모욕하려고하지 않고 이해합니다).