«code-documentation» etiketlenmiş sorular

Sorunların en hayati olmadığını biliyorum, ama javadoc yorum bloğunu ek açıklamadan önce veya sonra koyabileceğimi fark ettim. Bir kodlama standardı olarak neyi kabul etmek isteriz? /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired /** * This is a javadoc comment after …

184 java  coding-style  annotations  javadoc  code-documentation 

JSDoc'a döndürülen bir nesnenin yapısı hakkında nasıl bilgi verebilirim? @return {{field1: type, field2: type, ...}} descriptionSözdizimini buldum ve denedim: /** * 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 

Bir dize parametresini kabul eden bir işleve sahibim. Bu parametre, tanımlanmış birkaç olası değerden yalnızca birine sahip olabilir. Aynı şeyi belgelemenin en iyi yolu nedir? ShapeType, enum veya TypeDef veya başka bir şey olarak tanımlanmalı mı? Shape.prototype.create = function (shapeType) { // shapeType can be "rect", "circle" or "ellipse"... this.type …

96 google-closure-compiler  google-closure  jsdoc  code-documentation