It's a small jar that has classes without implementation that provide useful cheat sheet hints while you are working.
Here's what it looks like
The really interesting thing about this is it is a hack about using editor inline help solely for the purposes of help. This is something I have not seen done before.
Keep in mind that these java classes serve no purpose other than to provide documentation.
Because this is a new area, I wanted to share some lessons learned as well as places I think this could be expanded to.
Lessons Learned from version 1
Hack then Generate
Javadocs is a reasonable place to add documentation when coding, but it is not a good place write real documentation. Once you get the general idea and a few working prototypes, you are going to want to create a way to generate the documentation classes.
For example, here's how we created the Completions Tips data. We then generated both the mac and windows tip objects from here.
You can take a full look at the generation process here.
While the documentation rendering doesn't support much, you can use simple html like tables and images and UTF8 characters to make your text more readable. Just keep it simple.
Use tl;dr curation
A lot of the value is in the discoverability and quick readability. We approached this in a couple ways.
- We don't show all the tips, only the ones we judge 'most' useful
- We grouped things so you could focus on pieces, but we also had a full listing under .Mac()
- We named the groups starting with an underscore ( _Lines ) so they would be together in the editor
Possible Next Steps
- Visual Studio / Resharper (for vs keybindings & R# keybindings)
Example / Starter / Cookbooks for Api
When you are getting started you often find your way to websites to lookup quick getting started examples. This as stuff that doesn't exactly belong in the actual code itself. Especially as the examples might be how you discover the packages, class and methods you want to call.
I could easily see documentation classes for things like linq, unit testing, markdown, regex, etc.
Of course, you might want to put that directly on the methods (as documentation was originally intended) but this also opens up the ability to write a documentation project for a project you don't actually own yourself.
Let's see what the future will hold...
I'm excited to see what will come out of this discovery. If you have ideas please reach out to me on twitter ( @LlewellynFalco ) Share what you've created, or ping me and we can pair and create it together.