Make sure you have node and npm installed. Fortunately for us, it's quite easy to use Gulp to add these features. When working with other static site generators I've gotten used to niceties like built-in servers and live-reload. The only problem with docco is that it's a little too bare-bones. It bills itself as a "quick and dirty documentation generator" and was originally used to generate the documentation for underscore. To meet these requirements, I decided to use Docco. It shouldn't force me into any rdoc-like format.It should output HTML displaying both annotations and the full highlighted source code.Since I'd like to publish these annotations one day, I need a documentation generator to convert the source files into a website. I've also been writing pretty extensive annotations. I've always been fascinated by emulators, and when Yusuke Endoh released Optcarrot, a NES emulator written in Ruby I knew I had to take a look.įor the past three months, on nights and weekends, I've been poring over the source, figuring out just how an NES emulator works. But we're not going to be doing that today. Yes, there are issues, and often the sensible approach is to avoid comments altogether. Some people are good developers but poor writers. Most of the time, people don't maintain comments, or they do it in a half-assed way. When you're really trying to understand a code-base nothing beats well-written, extensive annotation. I'm going to tell you something very personal, and I hope you won't make fun of me. Ruby (179) Honeybadger (79) Rails (55) JavaScript (47) PHP (37) Python (26) Laravel (23) Briefing (13) DevOps (10) Go (10) Django (9) Elixir (8) Aws (8) Briefing 2021 Q3 (7) FounderQuest (6) Briefing 2021 Q2 (6) Node (6) Conferences (5) Testing (5) Security (4) Developer Tools (4) Elastic Beanstalk (4) Error Handling (4) Heroku (3) Debugging (3) Docker (3) React (3) Markdown (3) Events (2) Jekyll (2) Startup Advice (2) Guest Post (2) Sidekiq (2) Serverless (2) Git (2) Front End (2) Rspec (2) Oauth (2) Logging (2) GraphQL (2) Flask (2) Case Studies (1) Performance (1) Allocation Stats (1) Integrations (1) Bitbucket (1) Mobile (1) Gophercon (1) Clients (1) Vue (1) Lambda (1) Turbolinks (1) Redis (1) CircleCI (1) GitHub (1) Crystal (1) Stripe (1) Saas (1) Elasticsearch (1) Import Maps (1) Build Systems (1) Minitest (1) Guzzle (1) Tdd (1) I18n (1) Github Actions (1) Sql (1) Postgresql (1) Xdebug (1) Zend Debugger (1) Phpdbg (1) Pdf (1) Multithreading (1) Concurrency (1) Web Workers (1) Fargate (1) Websockets (1) Active Record (1) Django Q (1) Celery (1) Amazon S3 (1) Aws Lambda (1) Amazon Textract (1) Sucrase (1) Babel (1) Pdfs (1) Hanami (1) Discord (1) Active Support (1) Blazer (1) Ubuntu (1) Nextjs (1) DynamoDB (1)
0 Comments
Leave a Reply. |