Archive for 入門メモ

git pull requestメモ

  • githubでfork→作業→commit→rebaseでまとめる→push→GitHubでpull request
  • git rebase -i [対象commitのhash] → 対象commitのhash~現在までがでてくる
    • でてくるエディタで、pickをsquash にすると、その変更と直前の変更をまとめる

参考リンク

文章とか資料とか図表を書くときの注意

まとまった文章とか資料とか図表を書くとき向け。当たり前だけど気をつけるべきところなど。思いついたところから。ざっくばらんにですが。。。

その文章・資料の意味を考える

  • いま書いている文章・資料は何のために書くのか
  • 誰のために書くのか
  • 文章の頭に「文章の目的」と「対象読者」を書いておくとよい

資料を管理できるようにする

  • ページ数を降る
  • 書いているひとの名前を書く
  • 資料の作成日時・更新日時を頭に書いておく

文章のルールを決める

  • こういうときはこう表現する、と決める
  • 自己流でいいけど、分かる方法で決める。(文章内部に書く、など)

未定義かつ明らかでない表現は使わない

  • 「誰が見ても明らかに意味が分かる」ときを除いて、資料上で意味を定義する。
  • 赤矢印は○○という意味、太文字は○○という意味、等

何となく書かない

  • そこにそれが書いてある意味を考える。
  • 「そこにそれが書いてある意味は特にない」ということもある。しかし明確に区別されるべき。
  • そこに書いてあるものは伝わるか?そこに書く必要があるか?そこに書くべきものは足りなくないか?
  • 逆に、伝われば簡単な書き方、省略した書き方をする。常に文章は短い方がいい。

不要なクオリティを求めない

  • 書いている文章がどのクオリティを目指すべきなのか考える
  • 伝わればいい場合もあれば、外部に出しても恥ずかしくないにする場合、読み手に非礼がないよう丁寧にしなければいけない場合もある
  • 「伝わればいい」場合は、本当に伝わりさえれば、汚くてもいい、乱暴でもいい。誤字脱字にもこだわる必要もない。日本語文章になってなくてもいい(箇条書きとか)。そこにかける時間は無駄。
  • 「文章としてのクオリティ」を求める場合は、絶対に書き手以外の人がチェックする。自分では絶対誤りを見逃す。

「広く・浅く・抽象的」な説明から入り、「狭く・深く・具体的」な説明に入るように書く

  • 大まかな概要説明から入って、だんだん細かく各部を説明するようにする

「一般化された表現」と「例示」を両方書く

  • 一般化だけではうまく伝わらないことが多いし、例示だけだと「何のために例示したのか」が分からない。
  • (例) 「max(a,b) はaとbのうち大きい方を示す。(←一般) 例えばmax(5,7) は7を示す (←例示)」

同じ表現は同じ意味、違う表現は違う意味にする

  • 同じ表現なのに意味が違ったりすると混乱する
  • 全て統一されていると読みやすい
  • (a,b,c)と(d,e,f)は同じ意味にする、{a・b・c}と(d,e,f) は違う意味にする
  • (図を書くとき) 同じ図形かつ同じ色は同じ意味、違う図形や違う色の場合は違う意味にする、などなど

「動詞(句)」と「名詞(句)」の区別をする

  • システム関係では、名刺と動詞の区別を大切にするとわかりやすくなることが多々ある
  • 「関数の説明は動詞にする」、「変数の説明は名詞にする」などなど (ただしこのルールが絶対ではない)

JavaScriptの入門中の入門のカンペ

入門の入門部分だけざざっと。

★基本文法

コメント

 // ここはコメント
 /* ここもコメント */

関数(メソッド)定義

function 関数名( パラメータ ){
  // 関数の内容;
  //  ・・・
}

※パラメータ は省略可

関数(メソッド)呼び出し

// フツーの関数を呼ぶ
間数名( パラメータ );
// 返り値を変数に入れとく場合
変数 = 間数名( パラメータ );
// オブジェクトの関数 (メソッド) を呼ぶ
オブジェクト.メソッド名( パラメータ );

// 具体例 Math.max: 与えたパラメータのうち大きなほうを返すメソッド
var a = Math.max(5, 10); // aには 10 が代入される

※パラメータ は省略可

変数の操作

a = 5;  // aに5を代入する
a += 1; // aに1を足す
b = a * 6;  // bにaの五倍 (36になる) を代入する
s = '文字列'; // sに「文字列」と代入された
m = 'bの値は' + b + 'です'; // 連結: mに"bの値は36です" と代入される
n = "シングルクォートとダブルクォートはどっちでもいい";

条件分岐: if文

※「条件式」の書き方は次節

if( 条件式A ){
   // 処理内容; ←ここは「条件式A」が真のとき実行される
}
else if( 条件式B ){
   // 処理内容; ←ここは「条件式A」が偽だけど「条件式B」が真のとき実行される
}
else if( 条件式C ){
   // 処理内容; ←ここは「条件式A,B」が偽だけど「条件式C」が真のとき実行される
}
else{
   // 処理内容; ←ここは「条件式A,B,C」の全てが偽のとき実行される
}

※ 「else if(){ ~ }」や「else{ ~ }」 は省略できます。

ループ: for文

// 定型文
for(var 変数 = 初期値; 変数 < 終了値; 変数++){
    // 繰り返し行う処理内容
}

// 0~9まで「今の数字は○○です」と表示 (alert) させたい場合
for(var i = 0; i < 10; i++){
   alert('今の数字は' + i + 'です');
}
// ※ 「i < 9」ではなく「i < 10」なのに注意

 

条件式

※ 真=正しい、偽=ただしくない、みたいな感じ

// 基本形
(a == 50)   // aが50の場合に真
(a == "hoge") // aが"hoge"の場合に真
(a == b)   // aの内容とbの内容が等しい場合に真
(a != b)   // aの内容とbの内容が違う場合に真
(a > 5)   // aが5より大きい場合に真
(a < 5)   // aが5より小さい場合に真 if(a >= 5)   // aが5「以上」の場合に真
(a <= 5)   // aが5「以下」の場合に真

// 複合条件
( ! 条件式 )   // 「条件式」が偽の場合に真
(! (a == 4) )   // !の例: (a != 4) と同じ意味

( 条件式A && 条件式B ) // 「AかつB」: 条件式AとB両方共真の場合に真
( 条件式A || 条件式B ) // 「AまたはB」: 条件式AかB片方でも真の場合に真
( (a == 4) || (a == 5) )  // aが4か5の場合に真
( (1 <= a) && (a <= 10) )  // aが1~10の場合に真
(  1 <= a  &&  a <= 10  )  // 括弧は省略できる

★基本ライブラリ

デバッグ等のためにメッセージダイアログを表示する

alert('表示させたいメッセージ');

指定時間待って処理を続ける (setTimeout)

// 指定「ミリ秒」後に「関数」を呼び出す
setTimeout(関数, ミリ秒);

// 指定「ミリ秒」後にやりたい処理をベタ書きする
setTimeout(function(){
    // やりたい処理;
    //  ・・・
}, ミリ秒);

★jQuery等外部ライブラリのもの

初期化時に実行される処理の書き方(jQuery)

$(function(){
    // 初期化時にやりたいこと;
    //  ・・・
});

 

セレクタで指定した要素のCSSを変える (color, visibility とか)

$('セレクタ').css('CSS項目名', '変える値');

セレクタで指定した要素の「属性」を変える (src, href とか)

$('セレクタ').attr('CSS項目名', '変える値');

入門の入門でした。

以上。