वहाँ पहले से ही है टाइपप्रति अंदर एक्सएमएल प्रलेखन के लिए समर्थन करते हैं? ऐसा लगता है वहाँ नहीं है, लेकिन शायद मैं कुछ अनदेखी कर रहा हूँ।
मैं कुछ इस तरह करना चाहते हैं:
export class Point {
/// <summary>This is a Point class.</summary>
constructor (public x: number, public y: number) {
/// <summary>Creates a new Point object</summary>
/// <param name=x></param>
/// <param name=y></param>
}
}
भाषा विनिर्देश में इस का कोई जिक्र नहीं है, इसलिए वर्तमान में इस सुविधा के लिए कोई समर्थन नहीं है।
प्रयोग में केवल टिप्पणी वाक्य-विन्यास एक स्रोत फ़ाइल पर निर्भरता बनाने के लिए है:
/// <reference path="..."/>
आप कर सकते हैं इस तरह के परियोजना पृष्ठ पर इस रूप में सुविधाओं का सुझाव - तो यह भविष्य में अगर विचार लाभ कर्षण में भाषा के लिए जोड़ा जा सकता है।
के लिए क्या इसके लायक है, माइक्रोसॉफ्ट से नमूने टिप्पणी की इस शैली में शामिल है। लंबन नमूना से:
constructor(scrollableContent: HTMLElement, perspective: number) {
/// <param name="scrollableContent">The container that will be parallaxed.</param>
/// <param name="perspective">The ratio of how much back content should be
/// scrolled relative to forward content. For example, if this value is
/// 0.5, and there are 2 surfaces, the front-most surface would be scrolled
/// normally, and the surface behind it would be scrolled half as much.</param>
this.perspective = perspective;
this.surface = [];
this.content = scrollableContent;
$(scrollableContent).scroll((event: JQueryEventObject) => {
this.onContainerScroll(event);
});
}
जाहिर है JSDoc अब समर्थित है, कम से कम दृश्य स्टूडियो संहिता में, के रूप में मैं वर्तमान में यह वहाँ का उपयोग कर रहा है और यह IntelliSense पॉपअप में पता चलता है।