Pertanyaan yang diberi tag «code-documentation»

Saya tahu bahwa itu bukan masalah yang paling vital, tetapi saya baru sadar bahwa saya dapat meletakkan blok komentar javadoc sebelum atau setelah anotasi. Apa yang ingin kita adopsi sebagai standar pengkodean? /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired /** …

184 java  coding-style  annotations  javadoc  code-documentation 

Bagaimana saya bisa memberi tahu JSDoc tentang struktur suatu objek yang dikembalikan. Saya telah menemukan @return {{field1: type, field2: type, ...}} descriptionsintaks dan mencobanya: /** * 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 …

156 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

Saya memiliki fungsi yang menerima satu parameter string. Parameter ini hanya dapat memiliki satu dari beberapa kemungkinan nilai yang ditentukan. Apa cara terbaik untuk mendokumentasikan hal yang sama? Haruskah shapeType didefinisikan sebagai enum atau TypeDef atau yang lainnya? Shape.prototype.create = function (shapeType) { // shapeType can be "rect", "circle" or …

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