প্রশ্ন ট্যাগ «code-documentation»

আমি জানি যে এটি ইস্যুগুলির পক্ষে সবচেয়ে গুরুত্বপূর্ণ নয়, তবে আমি কেবল বুঝতে পেরেছি যে টীকাটি দেওয়ার আগে বা পরে জাভাদোক মন্তব্য ব্লকটি রাখতে পারি। কোডিং স্ট্যান্ডার্ড হিসাবে আমরা কী গ্রহণ করতে চাই? /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired …

183 java  coding-style  annotations  javadoc  code-documentation 

ফেরত দেওয়া কোনও জিনিসের কাঠামো সম্পর্কে আমি কীভাবে জেএসডোককে বলতে পারি। আমি @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 …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

আমার একটি ফাংশন হচ্ছে যা একটি স্ট্রিং প্যারামিটার গ্রহণ করে। এই পরামিতিটির কয়েকটি সংজ্ঞায়িত সম্ভাব্য মানগুলির মধ্যে একটি হতে পারে। একই নথির ভাল উপায় কি? শেপটাইপ কি এনাম বা টাইপডিফ বা অন্য কিছু হিসাবে সংজ্ঞায়িত করা উচিত? Shape.prototype.create = function (shapeType) { // shapeType can be "rect", "circle" or "ellipse"... …

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