NetBeans Forums
| View previous topic :: View next topic |
| Author |
Message |
aserron
Joined: 07 Jun 2011
Posts: 7
Location: Uruguay
|
 Posted: Thu Oct 13, 2011 6:18 pm Post subject: Javascript JSDoc, ScriptDoc Support |
 |
|
Netbeans states that support tags like @namespace.
But i dont find any page that really define which set of annotations are supported.
I need clean definition of what would expect regarding documentation and code assistence.
Please i love netbeans, point me to the correct please where i can discuss this and even help the comunity. |
|
| Back to top |
|
 |
paolosca
Joined: 09 Sep 2010
Posts: 384
|
| Posted: Sun Oct 16, 2011 7:21 am Post subject: Re: Javascript JSDoc, ScriptDoc Support |
|
|
On 10/14/2011 02:18 AM, aserron wrote:
| Quote: | Netbeans states that support tags like @namespace.
But i dont find any page that really define which set of annotations are supported.
I need clean definition of what would expect regarding documentation and code assistence.
Please i love netbeans, point me to the correct please where i can discuss this and even help the comunity.
|
Hi, I'm also looking for documentation regarding NetBeans support of
jsdoc but I couldn't find any, I'm still planing to document the js
libraries we made so I'm not really sure if there are unsupported tags
at the moment.
Running extracting strings in the javascript editor module I found the
following tags and I asssume they are all supported:
@argument
@augments
@cfg
@class
@config
@constructor
@deprecated
@description
@event
@example
@exception
@fileOverview
@function
@ignore
@inherits
@memberOf
@name
@namespace
@param
@private
@property
@return
@scope
@static
@type
For the details I follow the jsdoc toolkit handobook[1].
Regards,
Paolo.
[1] http://code.google.com/p/jsdoc-toolkit/wiki/TagReference |
|
| Back to top |
|
|
aserron
Joined: 07 Jun 2011
Posts: 7
Location: Uruguay
|
| Posted: Mon Oct 31, 2011 5:22 pm Post subject: |
|
|
Excellent move, at least we know which tags we shouldn't even try.
But don't expect tags work as they should, take this test.
| Code: | var Ns = {};
/**
* @inherits Array
*/
Ns.TestInherit = function(){
this.test = 1;
}
var nodoc = new Ns.TestInherit();
var arr = new TestInherit();
// doc, no array methods
nodoc.test;
// no doc, no array
arr;
/**
* @extends Array
*/
Ns.TestExtends = function(){
this.test = 1;
}
var noExtended = new Ns.TestExtends();
var extended = new TestExtends();
// documented, no array methods
noExtended;
// no class doc, array methods documented.
extended.concat(value1, value2, valueN); |
As you see "inherits" doesn't work, and "extends" add a global symbol that doesn't exist.
Still the parser automatic detect when you call a super class constructor in the constructor function.
We still need more data or simple final spec sheet from the developers!. |
|
| Back to top |
|
|
LeonPaulette
Joined: 09 Apr 2012
Posts: 1
Location: United States
|
| Posted: Mon Apr 09, 2012 12:18 pm Post subject: |
|
|
thank you paolosca and aserron!
it's a good thing i found the post - filling the gaps in my knowledge
there is surprisingly little information on the topic in the Internet
:/
______________________
free crossword puzzle maker |
|
| Back to top |
|
|
seeds
Joined: 10 Apr 2012
Posts: 1
|
| Posted: Tue Apr 10, 2012 10:28 pm Post subject: developers take a look |
|
|
ill second that, completion is buggy and should be reported
bump |
|
| Back to top |
|
|
|
|
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum
You can attach files in this forum
You can download files in this forum
|
|
FAQ
Search
Memberlist
Register
Profile
Log in to check your private messages
Log in
