Organize TODOs

statiolake · statiolake · commit f98167757f3a · 2020-04-06T21:40:26.000+09:00
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -2,25 +2,25 @@
 
 # Summary
 
-- [はじめに (TODO)](./introduction.md)
+- [はじめに](./introduction.md)
 - [AtCoderの環境について (TODO)](./todo.md)
   - [ソフトウェアのバージョンなど (TODO)](./todo.md)
   - [単一のソースファイル (TODO)](./todo.md)
   - [利用可能なクレート (TODO)](./todo.md)
 - [開発環境の準備 (TODO)](./installation/index.md)
   - [Rustツールチェインのインストール (TODO)](./installation/toolchain.md)
   - [ソースコードエディタの準備 (TODO)](./installation/editor.md)
-  - [Rust Language Server のインストール (TODO)](./installation/rls.md)
-  - [cargo-generateのインストール (TODO)](./installation/cargo-generate.md)
+  - [Rust Language Server のインストール](./installation/rls.md)
+  - [cargo-generateのインストール](./installation/cargo-generate.md)
 - [コンテストの参加方法 (TODO)](./participate/index.md)
-  - [コンテスト直前の事前準備 (TODO)](./participate/before-contest/index.md)
+  - [コンテスト直前の事前準備](./participate/before-contest/index.md)
     - [Cargoパッケージの作成 (TODO)](./participate/before-contest/generate-project.md)
     - [利用するクレートの選択とコンパイル (TODO)](./participate/before-contest/choose-crates.md)
     - [プロジェクトのコピー (TODO)](./participate/before-contest/copy-project.md)]
-  - [コンテスト開始後の流れ (TODO)](./participate/during-contest/index.md)
-    - [テストケースの作成 (TODO)](./participate/during-contest/write-tests.md)
+  - [コンテスト開始後の流れ](./participate/during-contest/index.md)
+    - [テストケースの作成](./participate/during-contest/write-tests.md)
     - [プログラムの作成 (TODO)](./participate/during-contest/write-program.md)
-    - [プログラムのテスト (TODO)](./participate/during-contest/test.md)
+    - [プログラムのテスト](./participate/during-contest/test.md)
     - [プログラムの提出 (TODO)](./participate/during-contest/submit.md)
 - [Tips（小技集） (TODO)](./todo.md)
   - [クレートの使用例 (TODO)](./todo.md)
diff --git a/src/installation/cargo-generate.md b/src/installation/cargo-generate.md
@@ -2,11 +2,9 @@
 
 # `cargo-generate` のインストール
 
-**TODO** このページは書きかけです。
-
 AtCoder で利用できる Rust のバージョンやライブラリを指定したプロジェクトを簡単に生成するために、 [atcoder-rust-base の ja ブランチ](https://github.com/rust-lang-ja/atcoder-rust-base/tree/ja)にプロジェクトの雛形を用意しています。この雛形は`cargo generate`というコマンドを使って展開するため、先にこのコマンドをインストールする必要があります。
 
-`cargo generate` サブコマンドを利用できるようにするには `cargo-generate` が必要です。端末 (Windows ユーザーの方はコマンド プロンプト) を開いて `cargo install cargo-generate` コマンドを実行してください。これだけでインストールできます。
+`cargo generate` サブコマンドを利用できるようにするには `cargo-generate` が必要です。端末 (Windows ユーザーの方はコマンド プロンプト) を開いて `cargo install cargo-generate` コマンドを実行してください。これだけでインストールは完了です。
 
 ```console
 $ cargo install cargo-generate
diff --git a/src/installation/editor.md b/src/installation/editor.md
@@ -1,8 +1,6 @@
 <!-- -*- coding:utf-8-unix -*- -->
 
-# ソースコードエディタの準備 (TODO)
-
-**TODO** このページは書きかけです。
+# ソースコードエディタの準備
 
 Rust プログラムのソースコードは単純なテキストファイルです。編集にはテキストエディタというプログラムを使います。単純にテキストを読み書きするという機能に限ればテキストエディタは OS にも付属していますが、よりプログラミングに特化した機能を多く揃えるテキストエディタが無料で簡単に使える時代ですので、ぜひ活用するべきです。それらのエディタが持つ機能には例えば次のようなものがあります。 (一例です)
 
@@ -20,3 +18,5 @@ Rust プログラムのソースコードは単純なテキストファイルで
 こういった機能は Language Server Protocol という共通の仕組みの上に実装されているので、これをサポートするエディタであればこれらの機能を享受できます。 Language Server Client を実装しているエディタは無数にあり、どれを使うかは完全に好みです。
 
 本説明はできるだけエディタによらないように進めていくつもりですが、エディタに特有の内容が現れるときは [Visual Studio Code](https://code.visualstudio.com/) を想定して説明します。それ以外のエディタを使われる方は適宜読み替えてお読みください。次節で Rust のコーディング支援機能を導入する方法を説明します。
+
+(TODO: Visual Studio Code のインストールと Rust (rls) 拡張機能のインストールを説明する)
diff --git a/src/installation/index.md b/src/installation/index.md
@@ -4,10 +4,8 @@
 
 **TODO** このページは書きかけです。
 
-
-
 この章では、手元のパソコンに Rust の開発環境と、テキストエディタとして [Visual Studio Code](https://code.visualstudio.com/) をインストールする方法について説明します。
 
-環境を手元に用意するメリットは普段使い慣れたエディタや環境でコーディングできるようになることです。開発環境を用意して Language Server Protocol に対応するエディタ ([Visual Studio Code](https://code.visualstudio.com/) など) を利用すれば、入力補完やリアルタイムのエラーチェックなど様々な機能の恩恵を受けることができます。逆に言うと、自分の使い慣れたエディタや環境を使いたいと思わずむしろ環境を整える方が面倒だと感じられる方は AtCoder のコードテスト (リンク準備中) を利用するのが最も簡単な方法です。外部ライブラリにまつわる互換性の問題もありません。
+環境を手元に用意するメリットは普段使い慣れたエディタや環境でコーディングできるようになることです。開発環境を用意して Language Server Protocol に対応するエディタ ([Visual Studio Code](https://code.visualstudio.com/) など) を利用すれば、入力補完やリアルタイムのエラーチェックなど様々な機能の恩恵を受けることができます。逆に言うと、自分の使い慣れたエディタや環境を使いたいと思わずむしろ環境を整える方が面倒だと感じられる方は AtCoder のコードテスト (TODO: リンクが完成次第挿入) を利用するのが最も簡単な方法です。外部ライブラリにまつわる互換性の問題もありません。
 
 既に Rust の開発環境がインストールされており、普段使い慣れたエディタや編集環境もあるという方には前半は全く不要な話となります。[`cargo-generate` のインストール](cargo-generate.md)へお進みください。それもインストールされている方はこの章で説明することはありませんので、実際に[参加方法の説明](../participate/index.md)へお進みください。
diff --git a/src/installation/rls.md b/src/installation/rls.md
@@ -2,8 +2,6 @@
 
 # Rust Language Server のインストール
 
-**TODO** このページは書きかけです。
-
 Rust Language Server (RLS) は、ソースコード編集中の様々な支援機能を提供するためのプログラムです。例えば、プログラムを編集しながらリアルタイムでエラー箇所をハイライトしたり、コード補完機能を提供したり、定義にジャンプしたり、簡単なドキュメントを表示したりといった様々な機能があります。使い慣れたエディタとともにこうした支援機能が使えることが、ローカルに Rust の環境を作る大きなメリットです。
 
 なお、こうしたコーディング支援機能が不要だと考える方はインストールをする必要はありません。
diff --git a/src/installation/toolchain.md b/src/installation/toolchain.md
@@ -1,6 +1,6 @@
 <!-- -*- coding:utf-8-unix -*- -->
 
-# Rust ツールチェインのインストール (TODO)
+# Rust ツールチェインのインストール
 
 **TODO** このページは書きかけです。
 
@@ -13,12 +13,17 @@
 
 OS によっては Rust を実行するのに追加のプログラムが必要になりますので、まずはそれをインストールしましょう。
 
-- Windows  
-    TODO: Visual Studio Build Tools などをインストール
+- Windows
+
+    (TODO: Visual Studio Build Tools をインストール)
+
 - macOS
-    TODO: Cコンパイラ (に付属するリンカー) のインストール
+
+    (TODO: Cコンパイラ (に付属するリンカー) のインストール)
+
 - Linux (Windows Subsystem for Linux を含む)  
-    TODO: Cコンパイラ (に付属するリンカー) のインストール
+
+    (TODO: Cコンパイラ (に付属するリンカー) のインストール)
 
 
 ## ステップ 2: Rustup のインストールスクリプトを実行する
@@ -27,12 +32,15 @@ OS によっては標準のパッケージ管理に Rust のパッケージが
 
 <https://rustup.rs/> にアクセスすると、お使いのプラットフォームに合わせてインストールスクリプトを実行する方法が表示されます。大きくは Windows と macOS/Linux で分かれます。
 
-- Windows  
+- Windows
+
     `rustup-init.exe` のような実行ファイルのダウンロードリンクが示されていると思いますので、それをダウンロードして実行します。
-- macOS / Linux (Windows Subsystem for Linux 含む)  
+
+- macOS / Linux (Windows Subsystem for Linux 含む)
+
     `curl` を用いてスクリプトをダウンロード・実行する方法が示されていると思います。書かれているコマンドをターミナルへ入力してください。
 
-TODO: 以下、スクリプトの指示に従ってインストールする方法とインストールを確認する方法を書く
+(TODO: 以下、スクリプトの指示に従ってインストールする方法とインストールを確認する方法を書く)
 
 
 ## ステップ 3: インストールされたことを確認する
diff --git a/src/introduction.md b/src/introduction.md
@@ -2,8 +2,6 @@
 
 # はじめに
 
-**TODO** このページは書きかけです。
-
 本書はAtCoderのコンテストにRustで参加するためのガイドブックです。
 
 
diff --git a/src/participate/before-contest/choose-crates.md b/src/participate/before-contest/choose-crates.md
@@ -2,6 +2,8 @@
 
 # 利用するクレートの選択とコンパイル
 
+**TODO** このページは書きかけです。
+
 先にも軽く触れた通り、依存クレートのコンパイルにはそれなりの時間がかかります。コンテストが始まってから最初の問題の提出前に実行するとなるとそれなりのタイムロスになります。そこで次の二つのことをコンテスト開始前に行ってしまい、コンテスト開始後になるべくスムーズに行動できるよう準備しておきましょう。
 
 ## 利用するクレートの選択
@@ -14,7 +16,7 @@
 
 利用するクレートの選択を終えたら、次は事前コンパイルを行います。
 
-TODO: コマンド プロンプトまたは端末を開き、プロジェクトのあるフォルダまで移動する方法を説明する
+(TODO: コマンド プロンプトまたは端末を開き、プロジェクトのあるフォルダまで移動する方法を説明する)
 
 端末を開いてプロジェクトのあるフォルダまで移動したら、次のようにビルドを行います。
 
diff --git a/src/participate/before-contest/copy-project.md b/src/participate/before-contest/copy-project.md
@@ -1,6 +1,8 @@
 <!-- -*- coding:utf-8-unix -*- -->
 
-# プロジェクトのコピー (TODO)
+# プロジェクトのコピー
+
+**TODO** このページは書きかけです。
 
 競プロで書くコードは書き捨てにする、という方は先程作ったプロジェクトをすべての問題で使いまわしても問題ありませんが、コードをずっと残しておきたいとか、あるいは詰まったから一旦保存しておいて別の問題に行きたいことがよくある、といった事情で、プロジェクトを予め問題数分用意しておきたい方もいるかと思われます。この作業も少々手間ですので、このようにされたい方はコンテスト前に準備しておくとよいでしょう。
 
@@ -10,10 +12,10 @@
 
 - Windows
 
-    TODO: ジャンクション (`mklink /J target /path/to/original/target`) または (必要ならローカルセキュリティポリシーまたはレジストリエディタを使って SeCreateSymbolicLinkPrivilege 権限を有効にして) シンボリックリンク (`mklink /D target /path/to/original/target`)
+    (TODO: ジャンクション (`mklink /J target /path/to/original/target`) または (必要ならローカルセキュリティポリシーまたはレジストリエディタを使って SeCreateSymbolicLinkPrivilege 権限を有効にして) シンボリックリンク (`mklink /D target /path/to/original/target`))
 
 - macOS または Linux
 
-    TODO: `ln -s /path/to/original/target target`
+    (TODO: `ln -s /path/to/original/target target`)
 
 ただし、このときはメインバイナリ `target/debug/<project-name>` すらも共有になってしまうため、別のプロジェクトを `cargo run` する前に `cargo clean -p <project-name>` としてバイナリを削除する必要があります。 `cargo` はおそらくソースファイルとバイナリの更新日時を比較してリビルドの要不要を判断しているため、状態によっては前のプロジェクトの成果物をそのまま実行してしまうことがあります。
diff --git a/src/participate/before-contest/generate-project.md b/src/participate/before-contest/generate-project.md
@@ -8,7 +8,7 @@
 
 まずは、今から参加するコンテストのソースコードを置くフォルダを準備してください。
 
-TODO: フォルダを作成してそこに cd する方法を説明する
+(TODO: フォルダを作成してそこに cd する方法を説明する)
 
 では、実際にプロジェクトを生成していきます。
 
diff --git a/src/participate/before-contest/index.md b/src/participate/before-contest/index.md
@@ -1,8 +1,6 @@
 <!-- -*- coding:utf-8-unix -*- -->
 
-# コンテスト開始前
-
-**TODO** このページは書きかけです。
+# コンテスト開始前の事前準備
 
 コンテストの開始前にプロジェクトを準備して一度ビルドしておくと、コンテスト開始後の動きがスムーズになります。特に初回ビルド時は依存クレートのコンパイルに時間がかかります。お使いのパソコンのスペックにもよりますが、もしすべてのクレートを有効にした場合は完了まで数分程度かかるとお考えください。
 
diff --git a/src/participate/during-contest/index.md b/src/participate/during-contest/index.md
@@ -1,8 +1,6 @@
 <!-- -*- coding:utf-8-unix -*- -->
 
-# コンテスト開始後
-
-**TODO** このページは書きかけです。
+# コンテスト開始後の流れ
 
 1. 問題を開き、テストケースを記述します。
 1. プログラムを書きます。
diff --git a/src/participate/during-contest/test.md b/src/participate/during-contest/test.md
@@ -1,7 +1,5 @@
 # プログラムのテスト
 
-**TODO** このページは書きかけです。
-
 一通り書き終わったと思ったら、提出前にまずは一度サンプルケースで答えが合うかどうかを確認してみましょう。コマンド プロンプトまたは端末を開いてプロジェクトフォルダに移動して、次のようなコマンドを実行します。
 
 ```console
diff --git a/src/participate/during-contest/write-tests.md b/src/participate/during-contest/write-tests.md
@@ -1,7 +1,5 @@
 # テストケースの作成
 
-**TODO** このページは書きかけです。
-
 Rust には組み込みでテストをするための機構が備わっています。これらの様式に則ってテストを書くと、 `cargo test` コマンドを実行するだけでテストを実行することができます。これを競プロでもサンプルケースが通るかどうかを確かめるのに利用することができます。この機能の使い方の例として、生成したテンプレートの `tests/sample_inputs.rs` には [AtCoder Beginner Contest 086 C - Traveling](https://atcoder.jp/contests/abc086/tasks/arc089_a) のサンプルケースが書かれています。
 
 > Note: 直接手と目で確認する場合や、別のコンテスト支援ツールを利用する場合などはこの手順は必要ありません。また `cargo test` を利用しない場合、サンプルのテストファイルは削除しても良いですし、しなくても特に問題はありません。
diff --git a/src/participate/index.md b/src/participate/index.md
@@ -2,7 +2,7 @@
 
 # コンテストの参加方法
 
-**TODO** このページは書きかけです。
+**TODO** この章は書きかけです。
 
 本章では、手元にAtCoderのジャッジサーバーの環境と同等のプロジェクトを用意してコンテストに参加する方法について説明します。
 
