forked from https://gist.github.com/chetan/1827484 which is from early 2012 and contains outdated information.
Templates to remind you of the options and formatting for the different types of objects you might want to document using YARD.
| #!/usr/bin/env bash | |
| # | |
| #/ Usage: app-env [[-e <DOTENV_FILE>]... ] [[-s <SOURCE_FILE>]... ] [--] <command> [<args>...] | |
| #/ app-env [-h|--help] | |
| #/ | |
| #/ Executes a given command with environment variables loaded from dotenv files. | |
| #/ Dotenv files are executed in current shell context, wrapped with `set -e'. | |
| #/ Source files, which are set with the `-s' flag will be included after `set +e' | |
| #/ It is possible to provide several files, just by using flags as many tymes as you need. | |
| #/ |
Hi there! Since this post was originally written, nvm has gained some new tools, and some people have suggested alternative (and potentially better) approaches for modern systems. Make sure to have a look at the comments to this article, before following this guide!
Trickier than it seems.
| # = Kernel#switch | |
| # Provides alternative switch-case syntax. | |
| # | |
| # # support methods: | |
| # value = [] | |
| # switch value do | |
| # on empty?: -> { "none" } | |
| # on one?: -> { "one" } | |
| # on many?: -> { "many" } | |
| # end |
| # helpers/bootstrap_helper/tabbable.rb | |
| # Bootstrap 2 tabs helper method for Ruby on Rails | |
| # http://getbootstrap.com/2.3.2/components.html | |
| # | |
| # == Usage (slim): | |
| # | |
| # = tabbable do |t| | |
| # = t.section :tab_1 do | |
| # / Content for Tab #1 |
| source :rubygems | |
| gem 'shotgun', :group=>:development | |
| gem 'rack-cache' | |
| gem 'sinatra', :require => 'sinatra/base' | |
| gem 'sinatra-support' | |
| gem 'haml' |
| moduleKeywords = ['included', 'extended', 'prototype'] | |
| class Class | |
| # Rename an instance method | |
| # | |
| # ``` coffeescript | |
| # class User | |
| # @alias "methods", "instance_methods" | |
| # | |
| # ``` |
