コードレビュー
説明文を文ごとに読点で区切ると、どういう断片が並ぶか。
コードレビューの目的,方法を理解する。また,コーディング標準を守っているか,ソフトウェア詳細設計書に基づいているか,効率性や保守性が適切かなどを確認することを理解する。
文ごとに読点で区切ると、一文目は 2 つ、二文目は 4 つの断片になる。 二文目は「また」で始まり、この「また」も 1 つの断片に数える。
一文目:
- コードレビューの目的
- 方法を理解する。
二文目:
- また
- コーディング標準を守っているか
- ソフトウェア詳細設計書に基づいているか
- 効率性や保守性が適切かなどを確認することを理解する。
細目名「コードレビュー」は、一文目の一つ目の断片「コードレビューの目的」の先頭の文字列である。二文目の二つ目の断片「コーディング標準を守っているか」は、3.(4)の細目名「コーディング標準」を持つ。断片どうしの係り方を、シラバスは書き分けていない。
用語例 ピアコードレビュー は、細目名とどう重なるか。
3 番目の ピアコードレビュー は、細目名「コードレビュー」の前に「ピア」を置いた文字列である。 2 番目の コードインスペクション も「コード」で始まる。5 語とも括弧書きを持たない。
5 語それぞれの意味と、ピアコードレビュー と細目名「コードレビュー」の関係を、シラバスは書いていない。
シラバスは、コードレビューの目的、方法を理解するとし、また、コーディング標準を守っているか、ソフトウェア詳細設計書に基づいているか、効率性や保守性が適切かなどを確認することを理解するとしている。用語例は 5 語で、5 語それぞれの意味は書かれていない。細目名「コードレビュー」は、説明文の先頭に現れる。説明文の各断片の中身も書かれていない。
用語例 5 語(シラバスの並び順のまま)
| 順 | 用語例 |
|---|---|
| 1 | メトリクス計測 |
| 2 | コードインスペクション |
| 3 | ピアコードレビュー |
| 4 | ウォークスルー |
| 5 | サイクロマティック複雑度 |
この表の「順」はシラバスの並び順であって、重要度でも実施の順序でもない。 5 語のいずれについても、意味はシラバスに書かれていない。
この細目でのシラバスの書き方
| 項目 | 記載 |
|---|---|
| 説明文 | 二文(84 字) |
| 一文目の文末 | 「コードレビューの目的,方法を理解する。」 |
| 二文目の文末 | 「〜効率性や保守性が適切かなどを確認することを理解する。」 |
| 説明文の「など」 | 1 箇所 |
| 説明文の中の括弧 | 無し |
| 用語例の数 | 5 |
| 括弧を持つ用語例 | 0 |
| 用語例の区分見出し | 無し |
シラバスが書いていること
Section titled “シラバスが書いていること”説明文は二文、84 字である。「など」は 1 箇所ある。括弧は無い。
1 番目の メトリクス計測 は、3.(8)④ の 1 番目の用語例と同じ文字列である。 メトリクス計測 と 3.(8)④ の メトリクス計測 の関係を、シラバスは述べていない。
二文目の「コーディング標準」は、3.(4)の細目名と同じ文字列である。 2 つの細目の関係を、シラバスは述べていない。
シラバスはこの細目を節 3 実装・構築 の(6)に置いている。
ほかの細目との文字列の重なり
Section titled “ほかの細目との文字列の重なり”- コーディング — 3.(1)の用語例 コーディング が、この細目の説明文に現れる
- コーディング標準 — 3.(4)の細目名が、この細目の説明文に現れる
- メトリクス計測 — この細目の用語例 メトリクス計測 が、3.(8)④ の用語例 メトリクス計測 にも現れる
(用語例の語全体・括弧の前の文字列と細目名が、ほかの細目の細目名・説明文・用語例に現れる組は、b26gen/ov.py で両方向に照合し、すべて挙げた。細目名・説明文・用語例の語の一部について重なる例はほかにもあり(「コード」「レビュー」など)、ここには挙げていない。英数字(と「/」「.」「-」)だけの語は、前後が英数字でない位置の一致だけを数えた(別の英語の一部として当たるものは除いた)。ほかの細目の用語例の括弧の中は、照合する先に含めていない(括弧の中に当たる一致は挙げない)。)
シラバスはこれらを結び付けていない。 文字列が同じことだけが事実である。
この細目で書かないこと
Section titled “この細目で書かないこと”次はいずれもこのノートの根拠に含まれていない。
- 5 語それぞれの意味
- 説明文の断片「コードレビューの目的」「方法を理解する。」の中身
- 説明文の断片「コーディング標準を守っているか」「ソフトウェア詳細設計書に基づいているか」「効率性や保守性が適切かなどを確認することを理解する。」の中身
- メトリクス計測 と 3.(8)④ の メトリクス計測 の関係
- この細目と 3.(4)コーディング標準 の関係
- ピアコードレビュー と細目名「コードレビュー」の関係
名前から内容を推測して書くことは spec.md §8.1a に反する。