Javascript Notes

Status Reports Basic overviews of what I have learned and assessments of technologies
SVN submitted Demos, code snippets and small projects that I have used to learn from. In SVN
//www.thoughtworks.com/radar/ Good Resource to see what tech folks are using.

Javascript resources

Javascript Notes Notes I have created for learning the basics of Javascript

Web Application resources

MVC

  • MVC Links and data on MVC application frameworks and libraries such as Angular or Backbone.

Bootstrap

bootstrap is used as a CSS framework. Works in conjunction with some JS/JQuery as well.

Node for J

  • Node - Notes on Node for J as well as Express and templating engines

Webapp stacks and web server technologies

Devstack

Our current Delevopment Stack

Websockets

Graphics

Misc other graphics and data stuff

UX

User Interfaces

Other interesting Javascript Technologies

Cloud servers

Cloud server notes

Documentation

Really links to Java and rest API hopefuls

Javascript Documention Projects

http://dailyjs.com/2011/01/13/framework-part-46/ - listing of hopefuls

  • docco Docco is a quick-and-dirty documentation generator, written in Literate CoffeeScript. It produces an HTML document that displays your comments intermingled with your code. All prose is passed through Markdown, and code is passed through Highlight.js syntax highlighting. Documents are not really API docs but code inspection docs. Code and comments appear side by side. I guess the style is what they are calling Literate Programming. Requires a bit of work to get it installed. Gotta add python and a Pygments.
  • Ronnjs looks like a decent little tool. Creates just Markdown docs. So it really requires a bit of a build process. Markdowns are easily converted to html.
  • jsDox jsdox is a simple jsdoc 3 generator. It pulls documentation tags based on a subset of jsdoc 3 from your javascript files and generates markdown files.

Java API Documentation

Personally, All I think we need a javadoc plugin that deals with Spring notation a little better. Is that too much to ask?

  • RestDoclet This is probably the one we want.
  • SpringDoclet SpringDoclet is a Javadoc doclet that generates documentation on Spring Framwork artifacts in a project. The detection of Spring artifacts is based on the presence of Spring annotations on Java classes and methods. I have used this. It really only produces one additional document and lumps all the rest into a single doc. Kinda good, kinda meh. Here is an example.
  • wsdoc Produces a kinda plain, but spring friendly document. Needs more investigation
  • Swagger A specification and complete framework implementation for describing, producing, consuming, and visualizing RESTful web services. Seems a bit much.
  • Enunicate Open-source documentation generation engine that is attached to the Java build process to generate HTML documentation. Not sure if it does the Rest/Sprint stuff
  • Doxygen - Doxygen is also a general purpose documentation tool that can be used for documenting APIs too. It generates either an on-line documentation browser (in HTML) and/or an off-line reference manual from documented source files.

Testing

http://qunitjs.com/

  • this shows both a good approach to incrementally adding to your code and testing it.

Included page "clone:robstavejs" does not exist (create it now)

Welcome to your Wiki, hosted by Wikidot.com. This is a template that will help you to get started with your community project, helping you to collaboratively work on and document your project with the help of other users. It uses Fereal's Monobook theme.

Page Tree

tosort

http://scotch.io/bar-talk/understanding-the-bootstrap-3-grid-system
http://scotch.io/tutorials/javascript/single-page-apps-with-angularjs-routing-and-templating

Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License