«javadoc» 태그된 질문

JavaDoc을 사용하여 클래스의 최종 정적 필드 값을 어떻게 참조 할 수 있습니까? ???이 예제에서 필드 값으로 대체 하고 싶습니다 STATIC_FIELD. /** * This is a simple class with only one static field with the value ???. */ public class Simple { /** * We can reference the value with {@value} …

96 java  documentation  javadoc 

속성과 getter 및 setter (DTO 스타일) 만 보유하는 "간단한"POJO 클래스의 속성 / 멤버에 대한 javadoc을 작성할 때 종종 딜레마가 발생합니다 .... 1) 속성에 대한 javadoc 작성 또는 ... 2) getter에 대한 javadoc 작성 속성에 대한 javadoc을 작성하면 나중에 코드 완성을 통해 POJO에 액세스 할 때 내 IDE (Eclipse)가 (당연히) 이것을 …

93 java  javadoc 

Eclipse에서 Intellij Idea로 마이그레이션 중입니다. 아직 알아낼 ​​수 없었던 한 가지는 @authorJavaDoc 태그의 자동 완성입니다 . @aEclipse에 입력 할 때 두 가지 제안이 있습니다. @author - author name @author Intellij에서 첫 번째 제안을 어떻게 달성합니까 (가능합니까?)? 가능한 경우 작성자 이름 자리 표시 자에 삽입 된 템플릿을 어떻게 변경합니까?

93 intellij-idea  javadoc 

JavaDoc 참조를 살펴 봤고 @see(다양한 링크)와 {@inheritDoc}(수퍼 클래스 JavaDoc 주석 내보내기 )의 기본적인 차이점을 이해하지만 실제로 구현 된 방법에 대한 설명이 필요합니다. Eclipse IDE에서 상속 된 메서드 (인터페이스 또는 toString () 재정의 등)에 대해 "요소 주석 생성"을 선택하면 다음 주석이 생성됩니다. /* (non-Javadoc) * @see SomeClass#someMethod() */ 내가 생산 JavaDoc을 …

89 java  javadoc  comments 

코드 (Javadoc) 문서화의 일부로 깊은 들여 쓰기를 사용하여 요소 간의 관계를 표시하려고한다고 가정하십시오. 다음과 같이 중첩 된 목록을 만들려면 어떻게해야합니까? 일부 요소 다른 요소 아직 다른 요소

88 documentation  javadoc  indentation  nested-lists 

자체 열거 형을 포함하는 클래스에 대한 javadoc을 작성하고 있습니다. 개별 열거 형에 대해 javadoc을 생성하는 방법이 있습니까? 예를 들어, 지금은 다음과 같습니다. /** * This documents "HairColor" */ private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED }; 그러나 이것은 모든 열거 형을 전체적으로 문서화합니다. 각 HairColor 값을 개별적으로 …

84 java  enums  javadoc 

저는 서명 만 다른 동일한 이름의 메서드를 많이 사용하는 API를 개발 중입니다. 사용자가 지정하지 않으려는 경우 기본적으로 다양한 값을 초기화한다는 점을 제외하면 모두 동일한 작업을 수행합니다. 이해하기 쉬운 예로서 public interface Forest { public Tree addTree(); public Tree addTree(int amountOfLeaves); public Tree addTree(int amountOfLeaves, Fruit fruitType); public Tree addTree(int amountOfLeaves, …

82 java  javadoc 

가능한 FAQ 종류의 질문에 대해 죄송합니다.하지만 답을 찾을 수 없습니다. Eclipse를 기억하는 한 Javadoc 주석의 빈 줄이 (소스 내 Javadoc 팝업에서) 줄 바꿈 (추가 세로 간격 포함)으로 표시됩니다. 그러나 Netbeans에서는 그렇지 않습니다. 빈 줄을 줄 바꿈으로 해석하도록 Javadoc을 구성 할 수 있습니까? 추가 질문 : 소스 내 Javadoc 팝업에 대한 …

81 java  netbeans  comments  javadoc 

현재 Java에서 코드를 depreacted로 표시하는 두 가지 방법이 있습니다. JavaDoc을 통해 /** * @deprecated */ 또는 주석으로 : @Deprecated 이것은 내 문제입니다. Eclipse를 사용할 때 메서드를 사용하지 않는 것으로 표시 할 때 둘 다 선언하는 것이 너무 많다는 것을 알았습니다. 나는 정말로 그들 중 하나를 사용하고 싶습니다. 그러나 주석을 사용하면 …

81 java  annotations  javadoc  deprecated 

클래스 위로 마우스를 가져 가면 jar 파일에 포함 된 javadoc 주석이 Eclipse에 표시되도록하고 싶습니다. 예를 들어, JODA-2.0을 다운로드하면 3 개의 jar가 생성됩니다. joda-time-2.0 joda-time-2.0-javadoc joda-time-2.0-sources ( http://sourceforge.net/projects/joda-time/files/joda-time/2.0/joda-time-2.0-dist.zip/download ) Eclipse에서 [마우스 오른쪽 버튼 클릭 프로젝트-> 속성-> Java 빌드 경로-> 라이브러리-> JAR 추가 ...]는 joda-time-2.0.jar의 프로젝트에 바이너리를 포함합니다 (해당 클래스를 참조 할 …

80 java  eclipse  jar  javadoc 

닫은. 이 질문은 Stack Overflow 지침을 충족하지 않습니다 . 현재 답변을 받고 있지 않습니다. 이 질문을 개선하고 싶으십니까? Stack Overflow의 주제에 맞게 질문을 업데이트하세요 . 휴일 육년 전 . 이 질문 개선 현실을 직시하자 : 기본 Javadoc이보기 흉해 보이기 위해 디자이너가 될 필요는 없습니다 . 웹에는 스타일이 변경된 Javadoc을 제공하는 …

80 java  documentation  javadoc 

현재 저는 JavaFX로 작업하고 있습니다. JavaFX 메서드 위로 마우스를 가져갈 때마다 다음 오류가 발생합니다. 'Note: This element neither has attached source nor attached Javadoc and hence no Javadoc could be found' 이 문제를 어떻게 해결해야합니까? 메소드에 대한 설명을 볼 수 있도록 javadoc 또는 소스를 어떻게 첨부 할 수 있습니까?

79 java  eclipse  javadoc  javafx-2 

Exit code: 1 - javadoc: error - The code being documented uses packages in the unnamed module, but the packages defined in https://docs.oracle.com/en/java/javase/11/docs/api/ are in named modules. 다른 포럼에서 제안한 것처럼 소스 버전을 1.8로 변경하지 않고도 javadoc을 사용할 수 있습니까? JDK v11.0.5를 사용하고 있는데 여전히 문제가 있습니다 (JDK 12+에서도). 편집 …

13 java  maven  javadoc  java-11  maven-javadoc-plugin 

Java 레코드 매개 변수를 어떻게 문서화해야 합니까? 생성자 매개 변수, 클래스 필드가되는 매개 변수를 말합니다. 나는 시도했다 : /** * @param name the name of the animal * @param age the age of the animal */ public record Animal(String name, int age) { } 그러나 IntelliJ IDEA는 @params를 오류로 표시합니다. …

12 java  intellij-idea  javadoc  java-14  java-record