codeincontext

config.after_initialize do
  class<<Rails.logger
    def debug_with_color(message)
      message_color = "0;32;1"
      colored_message = "\e[#{message_color}m#{message}\e[0m"

      debug_without_color(colored_message)
    end
    alias_method_chain :debug, :color
  end

codeincontext

// ==UserScript==
// @name          iPlayer Filter
// @namespace     http://skatty.me/
// @description   Hides crap shows from BBC iPlayer
// @include       http://bbc.co.uk/iplayer/*
// @include       http://www.bbc.co.uk/iplayer/*
// ==/UserScript==

var load,execute,loadAndExecute;load=function(a,b,c){var d;d=document.createElement("script"),d.setAttribute("src",a),b!=null&&d.addEventListener("load",b),c!=null&&d.addEventListener("error",c),document.body.appendChild(d);return d},execute=function(a){var b,c;typeof a=="function"?b="("+a+")();":b=a,c=document.createElement("script"),c.textContent=b,document.body.appendChild(c);return c},loadAndExecute=function(a,b){return load(a,function(){return execute(b)})};

codeincontext

file = '/Users/skattyadz/Dropbox/PlainText/FYP.txt'
toc = ''
number_stack = [0]

File.readlines(file).each do |line|
  if line[0] == '#'
    hash_count = line.count('#')
  
    if hash_count > number_stack.length
      # down a level

codeincontext

def self.nested_include(nested_attribute, additional_attributes=[], nesting_level=6)
  attributes = additional_attributes
  nesting_level.times do
    attributes = additional_attributes + [{nested_attribute => attributes}]
  end
  includes(attributes)
end

scope :with_nesting, nested_include(:children_ordered, [:user, :project])

codeincontext

Compiled jquery.tmpl.js  (0ms)  (pid 22675)
Compiled jquery.ui.datepicker-lb.js  (1ms)  (pid 22675)
Compiled jquery.ui.datepicker.js  (1ms)  (pid 22675)
Compiled jquery.ui.core.js  (1ms)  (pid 22675)
Compiled jquery.js  (1ms)  (pid 22675)
Compiled jquery.ui.datepicker-lv.js  (1ms)  (pid 22675)
Compiled jquery.ui.datepicker-vi.js  (1ms)  (pid 22675)
Compiled jquery.ui.datepicker-cy-GB.js  (1ms)  (pid 22675)
Compiled jquery.effects.clip.js  (1ms)  (pid 22675)
Compiled jquery.effects.core.js  (0ms)  (pid 22675)

codeincontext

\documentclass[a4paper,abstract=on,12pt]{scrartcl}
\usepackage{amssymb,amsmath}

\usepackage[a4paper]{geometry}
\geometry{margin=1in}

\usepackage{setspace}
\onehalfspacing

% These commands keep the koma system from making sans serif section headings

codeincontext

require 'timeout'

files_to_watch = %w{FYP.txt template.tex FYP.bib}

guard :shell do
  files_regex = Regexp.new(files_to_watch.join("|"))
  watch(files_regex) { regenerate }
end

def regenerate

codeincontext

The researcher believes that well written code should be self-documenting. Ruby code can be so similar to pseudo-code that descriptive commenting would only paraphrase the contents of the line, and could in fact make code less clear.

Below are some code samples from the project to demonstrate the self-descriptive nature of code.

validates_presence_of :password, :on => :create

This line tells the current model that it should validate the presence of a password when it is created.

This is a snippet from sessions_controller.rb, first uncommented, and then with 'descriptive' comments:

codeincontext

Handlebars.Utils.isEmpty = function(value) {
  if (typeof value === "undefined") {
    return true;
  } else if (value === null) {
    return true;
  } else if (value === false) {
    return true;
  } else if (value === '') {
    return true;
  } else if (value === 'null') {

codeincontext

// Constants
Solar = {
  START_HEALTH: 100,
  RADIUS: 10,
  COLOR: "FF0",
  RECYCLE: 50,
  RANGE: 50,
  ENERGY_PRODUCED: 0.5,
  STORAGE: 25,
  COST: 200,