概要
チートシートのフォーマット例をまとめました。いきさつとしてはプログラミング初心者を対象としたRuby教育の中で、学習のふりかえり用にチートシートがあるといいな〜と思い立ち記事を作成しました。参考になれば幸いです。
なお、チートシートは簡単な実行例に留めておき、比較やメモなどは別ファイルにとりまとめます。
チートシート フォーマット
CheatSheetFormat.txt
■項目名
・メソッド名など
DESCRIPTION: 概要説明
SYNOPSIS: 記法
EXAMPLE: 使用例
-> Stdout: 実行結果
チートシート 記入例
CheatSheet.rb
■標準入出力(standard streams)
・puts
DESCRIPTION: 標準出力(stdout)、引数のオブジェクトを文字列に変換、改行を加えて出力
SYNOPSIS: puts (arg, ...)
EXAMPLE: puts "This is string."
-> stdout: This is string.
・p
DESCRIPTION: 標準出力(stdout)、引数のオブジェクトを分かりやすい文字列に変換、改行を加えて出力
SYNOPSIS: p (arg, ...)
EXAMPLE: p "This is string."
-> stdout: "This is string."
メモ 記入例
CheatSheetMemo.rb
■標準出力(stdout)の比較
・print, puts, pの違い
printは改行コードを含めない、putsは自動的に改行コードを加えて出力
pはprint, putsとは異なり引数のオブジェクトを分かりやすい文字列にして出力
EXAMPLE:
string0 = "Hello,"
string1 = "World!"
array0 = [0, 1, 2]
array1 = ["3", "4", "5"]
print string0, string1
-> stdout: Hello,World!
print array0, array1
-> stdout: [0, 1, 2]["3", "4", "5"]
puts string0, string1
-> stdout: Hello,
World!
puts array0, array1
-> stdout: 0
1
2
3
4
5
p string0, string1
-> stdout: "Hello,"
"World!"
p array0, array1
-> stdout: [0, 1, 2]
["3", "4", "5"]