Comments (4)
The second syntax should already work. The first syntax will never work because example could be the name of the property.
from js-doc-parse.
I confirm, the second syntax works (tested with the latest js-doc-parse). Great, thanks.
For the first syntax, well, we could imagine avoiding the ambiguity you mention by using a more distinctive name than "example", say "doc-example" or "js-doc-example". Or we could even wonder why the name of the property needs to be repeated in the doc comment and redesign the syntax for doc comments of properties to be more consistent with the one in use for methods. Say:
// summary:
// This is a property.
// type:
// Number
// example:
// | some example
myProp: null,
Of course, this is just brainstorming about future evolutions.
from js-doc-parse.
I confirm, the second syntax works (tested with the latest js-doc-parse). Great, thanks.
For the first syntax, well, we could imagine avoiding the ambiguity you mention by using a more distinctive name than "example", say "doc-example" or "js-doc-example". Or we could even wonder why the name of the property needs to be repeated in the doc comment and redesign the syntax for doc comments of properties to be more consistent with the one in use for methods. Say:
// summary:
// This is a property.
// type:
// Number
// example:
// | some example
myProp: null,
Of course, this is just brainstorming about future evolutions.
from js-doc-parse.
I confirm, the second syntax works (tested with the latest js-doc-parse). Great, thanks.
For the first syntax, well, we could imagine avoiding the ambiguity you mention by using a more distinctive name than "example", say "doc-example" or "js-doc-example". Or we could even wonder why the name of the property needs to be repeated in the doc comment and redesign the syntax for doc comments of properties to be more consistent with the one in use for methods. Say:
// summary:
// This is a property.
// type:
// Number
// example:
// | some example
myProp: null,
Of course, this is just brainstorming about future evolutions.
from js-doc-parse.
Related Issues (20)
- return query(...) // dojo/NodeList not working HOT 2
- property's summary gets assigned to the property's value HOT 4
- monkey-patched functions erase original function doc HOT 4
- fx.js makes other file lose easing and duration kwargs definition HOT 3
- kwargs definition using declare() to extend from plain function() broken HOT 1
- inline expansion of union types with kwargs doesn't work HOT 2
- comment on line declaring export variable masks summary HOT 3
- fragile regex for union types HOT 1
- inline return types often ignored HOT 1
- properties added from one module to another sometimes don't show up HOT 1
- dojodoc for properties with dashes ignored HOT 1
- js-doc-parser errors HOT 2
- Ubuntu/Canonical process.execPath = /usr/bin/nodejs HOT 1
- Add support for documenting attach points and attach events HOT 2
- tree.json no longer generated HOT 1
- ERR: TypeError: Object true has no method 'match' HOT 6
- parse.bat config = ./config.js produces error "ERR: TypeError: Object true has no method 'match'" HOT 1
- dynamic AMD require
- js-doc-parse traces when require()ing external url
- UMD modules HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from js-doc-parse.