«code-documentation» 태그된 질문

가장 중요한 문제는 아니지만 주석 앞뒤에 javadoc 주석 블록을 넣을 수 있다는 것을 알았습니다. 코딩 표준으로 채택하고 싶은 것은 무엇입니까? /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired /** * This is a javadoc comment after the annotation */ private MyOtherClass …

183 java  coding-style  annotations  javadoc  code-documentation 

JSDoc에 반환되는 객체의 구조에 대해 어떻게 알 수 있습니까? @return {{field1: type, field2: type, ...}} description구문 을 찾아서 시도했습니다. /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or a jQuery event wrapping such an * …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

하나의 문자열 매개 변수를 받아들이는 함수가 있습니다. 이 매개 변수는 정의 된 몇 가지 가능한 값 중 하나만 가질 수 있습니다. 이를 문서화하는 가장 좋은 방법은 무엇입니까? shapeType을 enum 또는 TypeDef 또는 다른 것으로 정의해야합니까? Shape.prototype.create = function (shapeType) { // shapeType can be "rect", "circle" or "ellipse"... this.type = …

98 google-closure-compiler  google-closure  jsdoc  code-documentation