Skip to content

Commit

Permalink
feat: write example tag document
Browse files Browse the repository at this point in the history
To notify when example tag should be used.

ref:
- #487
- #481
  • Loading branch information
yumetodo committed Dec 8, 2017
1 parent 7c34549 commit 668ce5f
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 0 deletions.
2 changes: 2 additions & 0 deletions editors_doc/class_template_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ namespace std {
## 概要
(ここには、クラスの概要を記述します。必須事項です。)
(サンプルコードが必要な場合は`example`タグを付け、コンパイル・実行可能にすることを検討してください。(ref: [cppref特有の拡張構文](specialized.md)))
(必要な項目を省略する場合には、「(執筆中)」と書いておいてください。)
## メンバ関数
Expand Down
2 changes: 2 additions & 0 deletions editors_doc/function_template_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ void definition(); // 関数・変数・定数の宣言を記述します。
## 概要
(ここには、関数・変数・定数の概要を記述します。必須事項です。)

(サンプルコードが必要な場合は`example`タグを付け、コンパイル・実行可能にすることを検討してください。(ref: [cppref特有の拡張構文](specialized.md)))

(必要な項目を省略する場合には、「(執筆中)」と書いておいてください。)


Expand Down
2 changes: 2 additions & 0 deletions editors_doc/header_template_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

(ここには、このヘッダファイル(ライブラリ)の概要を記述します。必須事項です。)

(サンプルコードが必要な場合は`example`タグを付け、コンパイル・実行可能にすることを検討してください。(ref: [cppref特有の拡張構文](specialized.md)))

(必要な項目を省略する場合には、「(執筆中)」と書いておいてください。)

| 名前 | 説明 | 対応バージョン |
Expand Down
2 changes: 2 additions & 0 deletions editors_doc/lang_template_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
## 概要
(ここには、言語機能の概要を記載します。)

(サンプルコードが必要な場合は`example`タグを付け、コンパイル・実行可能にすることを検討してください。(ref: [cppref特有の拡張構文](specialized.md)))

(必要な項目を省略する場合には、「(執筆中)」と書いておいてください。)


Expand Down
26 changes: 26 additions & 0 deletions editors_doc/specialized.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,32 @@ int main() {
}
```

## exampleタグ

includeとmain関数を含む**原則すべてのC/C++言語のコードブロック**には`example`タグをつけてください。
`example`タグが付いたコードブロックはその場で実際にコンパイル・実行することができるようになります。
たとえコンパイルエラーになる場合でも、利用者がその場でコードを書き換えて試行することを容易にするために原則つけてください。

````
```cpp example
#include <iostream>
int main()
{
std::cout << "arikitari_na_world" << std::endl;
}
```
````

つけない例としては次のような宣言が書いてあるのみのものが挙げられます。

```cpp
namespace std {
template <class T, class Allocator = allocator<T>>
class vector;
}
```
## プログラムの修飾
コードブロックの直後に特定の構文で記述することで、コードブロックの一部を修飾できます。
Expand Down
2 changes: 2 additions & 0 deletions editors_doc/type-type_template_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ typedef origin_type new_type;
## 概要
(ここには、型の概要を記述します。必須事項です。)

(サンプルコードが必要な場合は`example`タグを付け、コンパイル・実行可能にすることを検討してください。(ref: [cppref特有の拡張構文](specialized.md)))

(必要な項目を省略する場合には、「(執筆中)」と書いておいてください。)

これは、メンバ型等の、型の別名定義を解説するページの雛形です。
Expand Down

0 comments on commit 668ce5f

Please sign in to comment.