ScriptDoc的Notation规则-优快云博客

本文链接：https://blog.youkuaiyun.com/QuLong/article/details/83533192

本文介绍Aptana Studio中ScriptDoc系统的各种标签及其用途，包括类、函数和属性的描述、作者信息、版本号等元数据，帮助开发者更好地理解并使用这些标签进行代码注释。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

这个还是蛮重要的，以前就一直很羡慕Java有一套标准来着：
转自：https://aptanastudio.tenderapp.com/faqs/using-code-assist/scriptdoc-tag-quick

[quote]This page provides an at-a-glance reference for the tags for the Aptana ScriptDoc system. For comprehensive ScriptDoc tag information, including syntax and examples, see the [ScriptDoc comprehensive tag reference] page.
Tag Description
[@alias] ID for a class or function.
[@author] Author of a JavaScript file or function.
[@classDescription] Description of the class (if applicable).
[@constructor] Signifies that a function is a constructor for a class.
[@deprecated] Signifies that a function or a property has been deprecated.
[@exception] Specifies the type of exception thrown by a function.
[@id] Unique identifier for a function or property.
[@inherits] Indicated one "class" derives from another.
[@memberOf] Signifies that a function is a member of the specified class.
[@method] Signifies that a function is a method of a class, if applicable.
[@namespace] Creates the link between the namespace of a library file and an external .sdoc file.
[@param] Use @param to tag each parameter for a function.
[@projectDescription] Gives a description of the JavaScript file.
[@return] Specifies information about the return value(s) of a function.
[@sdoc] Defines the path to an external .sdoc file for a library file.
[@see] Links to another related class or function.
[@since] Specifies since which version the library, function, or property became valid.
[@type] Specifies what data type a property is.
[@version] Specifies the version number of the JavaScript file or class.[/quote]