Is there are any comments documentation format for JavaScript and processor for this format which generates HTML documentation?
Currently I am using VSDoc xml comments for providing IntelliSense help at developing time, but as I know there is no documentation generator for such comments.
So alternatively my question may sounds like: Is there are any utility which translates VSDoc comments from JavaScript files to HTML?
Have you looked at auto generated documentation from JavaDoc or VSDoc or JSDoc or anything like that.
They are all ugly and un-readable.
The solution is two fold
annotate your code with docco
Make your API documentation hand written.
There is a third option which is to revolutionize the way we do auto generated documentation, if you can then please do.
I've used Natural Docs for a few projects. The syntax is nice for reading the inline, but since it doesn't have "full language support" for JavaScript, you have to be somewhat explicit about each function/constant/class/whatever you want to document.
There is a utility that parses Javascript files and outputs the same XML format NDoc and Sandcastle use: AjaxDoc
That way you get the VS intellisense from the same comments and can output any format that you want.
Related
I'm trying to make a little converter from wk1 (lotus-1-2-3) files to excel for a friend. The files have only simple data, no functions or anything really complicated.
I couldn't find anything related to guidelines to parse or documentation of wk1 file structure. I already tried going through libreoffice code but my C++ is very rusty (academic level, 6 years ago).
I usually code in PHP and JavaScript, and I didn't find anything related to this for these languages.
I believe I read somewhere that Lotus-1-2-3 is abandonware now, so I don't think is "illegal" or anything.
Is there any information available about this? What would be the best approach to "decoding" the data (other than that just give up)?
Thanks
For me there is no reason to re-invent the wheel...
There is a free software that can convert these files.
It is even available as portable app AND it has a command- line parameter to convert between formats:
soffice --headless --convert-to <TargetFileExtension>:<NameOfFilter> file_to_convert.xxx
So if you really need an "own" program: package it with the portable version of libreoffice and make a nice interface to select the source and target file and run the command line...
I am new to IntelliJ Idea
I want to add jsdoc for JavaScript core
That means, when I press the ctrl+q short key on a javascript element like .getElementsByTagName() method , I want to see the documentation, but there is not any thing!
Is there any way?
Like adding documentation jar file near to a library jar file for showing documentation.
Thanks
Mohi
Documentation is taken from the DOMCore.js stub file that doesn't contain a lot of useful information:
If you know where to find or how to generate similar stub file with complete documentation, it should be possible to use it instead.
I was wondering, if in C# under Visual Studio i can make xml comments, and java create's documentation base on annotation with javadocs, Exit's in somehow to create a nicer documentations base in comments in javascript?.
Something like the xml comments of c# like this
///<sumary> <===tags like this
There are various libraries for doing this. For example, http://code.google.com/p/jsdoc-toolkit/
I want to see my methods' documentation when I use CTRL-space on a method name while coding.
How should I format comments in my JavaScript methods and classes for re#er?
ReSharper 6 added support for JavaScript, CSS and HTML. ReSharper is using the same XML documentation annotations that are driving the JavaScript IntelliSense in Visual Studio. The XML format is an extension of the format that C# and VB.NET are using so it should look familiar to .NET developers. The main differences are the additional attributes that have been added to convey the (optional) type information that is not provided by the language itself and the place where those comments are written.
For more information take a look at these pages:
The format for JavaScript doc comments
VS 2008 JavaScript Intellisense
AjaxDoc: Generates documentation for JavaScript script libraries
Trying to find a way to automate the API from javascript comments.
The JSDoc project is no longer active, you should give a look to JsDoc Toolkit.
You might also want to check the following alternatives:
YUIDoc
PDoc
JSDoc http://jsdoc.sourceforge.net/
JSDoc Toolkit
jGrouseDoc
YUI Doc
jsd100
DocumentJS
I know its a lot late but since no one mentioned, I think Docco is a great tool. I use it for javascript but this tool can be used for other types of files too.