search

johnpapa / angular-styleguide

Angular Style Guide: A starting point for Angular development teams to provide consistency through good practices.
http://johnpapa.net
MIT License
23.84k stars 4.15k forks source link

JSDoc types #455

Open kurideja opened 9 years ago

kurideja commented 9 years ago

I was wondering about types/constructors. Here you suggest {String} as type definition for a string parameter. The original JSDoc seems to use lowercase type names for scalars and uppercase constructor names for Objects or Arrays.

Is there any particular reason you define string with constructor name (String) rather than its type (string)?

johnpapa commented 9 years ago

nope ... in fact, id love to see some guidelines with some code setup isntructions on how to use jdoc in this issue to help folks use it with the guide. interested in helping contribute that and adjusting the guide with a PR for any changes needed?

kurideja commented 9 years ago

Will look into it next week ;)

johnpapa commented 9 years ago

looking forward to this!

Nazanin1369 commented 8 years ago

Is there anyone working on this? otherwise I would like to enhance the JSDoc section.

kurideja commented 8 years ago

@Nazanin1369 , I got extremely busy after opening the ticket. Feel free to work on this.

Nazanin1369 commented 8 years ago

@kurideja sure.

Nazanin1369 commented 8 years ago

@johnpapa removed the descriptions in last commit. Do we want to include an example from ngdoc also?

sukrosono commented 8 years ago

IMO it will be clear with an example :smile:

johnpapa commented 8 years ago

anyone want to make a PR for this?

kurideja commented 8 years ago

Hey @johnpapa , it's been more than a year since I opened this thread 😞

Take a look at my JSDoc gist.

We seem to like it this way at work. Not using @memberOf or @namespace didn't seem like an issue so far with multiple and rather big projects.

If we are on the same page, I could start PRs in some time.