Comments (6)
I agree with Hopiu, acorn looks like it can make our lives easier. I would suggest to create an object like
function JSDocsObject (string) {
//@constructor...
}
JSDocsObject.prototype = {
//----------------------------------------------
// PRIVATE METHODS
//----------------------------------------------
_getReturnType : function() {...},
//----------------------------------------------
// PUBLIC METHODS
//----------------------------------------------
genJSDocs: function() {}
}
from annotate-extension.
I agree with you guys, regexps can only go so far. I have no experience with acorn though, and I'm just wondering if this isn't a bit oversized for the job.
@Hopiu , from your experience, what do you think? Do you think it's suited, performance wise?
from annotate-extension.
Performance wise I think it's not a problem. If it's a bit oversized, ummm, maybe but still I think it's better to use a parser than regexps that will never understand the code.
@davidderaedt How about creating a new branch where we could start getting something together?
@ajorquera Let's use the coding guidelines from https://github.com/adobe/brackets/wiki/Brackets-Coding-Conventions
Generally, isn't there something like the CodeHintManager but targeting Docs? I mean, JS is not the only language that needs Documentation.
from annotate-extension.
Good question about the CodeHintManager, I'll try to investigate that. In the meantime, I'm creating the acorn branch. Not sure I'll have the time to actually code anything before a while though, so feel free to go crazy. ;)
from annotate-extension.
Sorry @Hopiu I don't quite understand the purpose of the link you sent me. I mean, it doesn't talk about coding conventions for creating objects. I just wanted for us to focus on creating them.
from annotate-extension.
@ajorquera Oh, sorry I got that wrong. It's absolutely fine for me creating such an object.
from annotate-extension.
Related Issues (19)
- function code is corrupted HOT 2
- JSDoc Annotation in one row HOT 3
- Lost character
- prototype function HOT 1
- Bad fomatting HOT 1
- Does not work with function expressions HOT 1
- Doesn't find object functions
- Design of project HOT 2
- Generate JSDoc after typing /** HOT 1
- return values are not processed
- Slow in this version
- Description exists
- Not working inside your own extension
- Annotations are not indented
- shortcut interferes with native "delete line" HOT 4
- Not finding functions HOT 6
- Step Through Editing HOT 1
- Ctrl + Alt + A doesnt work HOT 2
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 annotate-extension.