code-documentation पर टैग किए गए जवाब

मुझे पता है कि यह मुद्दों की सबसे महत्वपूर्ण बात नहीं है, लेकिन मुझे सिर्फ एहसास हुआ कि मैं घोषणा से पहले या बाद में javadoc टिप्पणी ब्लॉक डाल सकता हूं। एक कोडिंग मानक के रूप में हम क्या अपनाना चाहेंगे? /** * This is a javadoc comment before the …

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 * …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

मेरे पास एक फ़ंक्शन है जो एक स्ट्रिंग पैरामीटर को स्वीकार करता है। इस पैरामीटर में कुछ परिभाषित संभावित मानों में से केवल एक हो सकता है। उसी दस्तावेज का सबसे अच्छा तरीका क्या है? क्या आकृति को Enum या TypeDef या कुछ और के रूप में परिभाषित किया जाना …

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