Comments (4)
It's always "the thing between the end of type and start of description.
Only on certain tags. Which is irritating, because it's not documented well. There is no official specification that I'm aware of. I tested hundreds of tags against 5 or 6 popular libs and the results were inconsistent.
from parse-comments.
I'll try later the whole v1 to see what's done.
Great! Fwiw you might find this helpful: https://github.com/jonschlinkert/parse-comments/blob/master/docs/content/comparison.md. The "type" parsing was one of the most complicated parts of this.
from parse-comments.
In a future version, you will be able to customize this to be like js-doc. Although I personally dislike that format because it's not clear to readers or parsers what's really intended. There are always exceptions where js-doc is wrong.
from parse-comments.
it's not clear to readers or parsers what's really intended
What's not clear? It's always "the thing between the end of type and start of description. Whatever it be, it's always between two spaces.
I'll try later the whole v1 to see what's done.
from parse-comments.
Related Issues (16)
- lodash is not included in dependencies HOT 1
- Get error when install
- Dependency vulnerabilities for set-value package HOT 1
- code.context is an empty object HOT 4
- Suggest to enable use other comment strings except `/*` HOT 5
- tag.type problems
- regex for stripping asterisks
- Browserify error: Error: Can't walk dependency graph: Cannot find module './formatter' from HOT 1
- Multiple paragraphs HOT 1
- `@option` gets ignored HOT 6
- Class misidentified as a method HOT 1
- should detect `@example`, `@public` and `@private` HOT 2
- module.exports and `@name` HOT 2
- suggestion for `@option` and `@property` and indenting
- respect `@throw(s)` tags
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 parse-comments.