Karol Marcjan szabba

## clean_code.md

      
              1 file
            
          
              0 forks
            
          
              0 comments
            
          
              0 stars
            
          
                szabba
                / clean_code.md
            
            
              Created
              March 2, 2017 20:37
                — forked from wojteklu/clean_code.md
            
              
                Summary of 'Clean code' by Robert C. Martin
              
          
    Code is clean if it can be understood easily – by everyone on the team. Clean code can be read and enhanced by a developer other than its original author. With understandability comes readability, changeability, extensibility and maintainability.

General rules


Follow standard conventions.
Keep it simple stupid. Simpler is always better. Reduce complexity as much as possible.
Boy scout rule. Leave the campground cleaner than you found it.
Always find root cause. Always look for the root cause of a problem.

Design rules


## Main.elm
module Main exposing (..)

import Html exposing (..)
import Html.Attributes exposing (..)
import Platform.Sub as Sub
import Html.Events exposing (..)
import Dict exposing (..)
import Debug as D exposing (..)

type Msg

## .gitignore
elm-stuff/

## .gitignore
elm-stuff/

## Dropdown.elm
module Dropdown where

import List exposing (..)
import Html exposing (..)
import Html.Attributes exposing (style)
import Html.Events exposing (onClick, onBlur)


-- MODEL

## loading_proces.cpp
void load_initial_level() {
	load(0);
}

void load_next_level() {
	load(variables.level);
}

typedef void (*process_loading_func)();

## playground.rs
// Can I have two mut references to different parts of a structure
// simultaneously?

struct Point {
    x: f64,
    y: f64,
}

fn main() {
    let mut p = Point{x: 3.0, y: 5.0};

## man.sh
#!/bin/sh

# man.sh - `man` replacement for git bash on windows

# Dependencies (outside of git bash):
#  wget (http://users.ugent.be/~bpuype/wget/)

# TODO:
#  use sed to remove <head> & tags, convert HTML entities

## pbook in sed
sed -E -e 's/^/    /g' -e 's/^    --- ?//g' | pandoc -o listing.pdf -

That expression is a cheap literate programming system for Markdown.
Start commentary lines with '--- ' and they will be
markdown-formatted, the rest will be code. (Uses Lua comment syntax.)

Finally the right implementation of this idea:
  http://fresh.homeunix.net/~luke/misc/emacs/pbook.pdf (program)
  http://fresh.homeunix.net/~luke/misc/erlang/regtest.pdf (better example)
	module Main exposing (..)

	import Html exposing (..)
	import Html.Attributes exposing (..)
	import Platform.Sub as Sub
	import Html.Events exposing (..)
	import Dict exposing (..)
	import Debug as D exposing (..)

	type Msg
	module Dropdown where

	import List exposing (..)
	import Html exposing (..)
	import Html.Attributes exposing (style)
	import Html.Events exposing (onClick, onBlur)


	-- MODEL
	void load_initial_level() {
	load(0);
	}

	void load_next_level() {
	load(variables.level);
	}

	typedef void (*process_loading_func)();
	// Can I have two mut references to different parts of a structure
	// simultaneously?

	struct Point {
	x: f64,
	y: f64,
	}

	fn main() {
	let mut p = Point{x: 3.0, y: 5.0};
	#!/bin/sh

	# man.sh - `man` replacement for git bash on windows

	# Dependencies (outside of git bash):
	# wget (http://users.ugent.be/~bpuype/wget/)

	# TODO:
	# use sed to remove <head> & tags, convert HTML entities
	sed -E -e 's/^/ /g' -e 's/^ --- ?//g' \| pandoc -o listing.pdf -

	That expression is a cheap literate programming system for Markdown.
	Start commentary lines with '--- ' and they will be
	markdown-formatted, the rest will be code. (Uses Lua comment syntax.)

	Finally the right implementation of this idea:
	http://fresh.homeunix.net/~luke/misc/emacs/pbook.pdf (program)
	http://fresh.homeunix.net/~luke/misc/erlang/regtest.pdf (better example)