プログラマーじゃない人に覚えてほしいプログラムのコメントの書き方
をテンプレートにして作成
[
トップ
] [
新規
|
一覧
|
単語検索
|
最終更新
|
ヘルプ
]
開始行:
この記事は、ただの思考実験です。
プログラマじゃない人に、EclipseなどのIDEによるサポートと...
そもそも、どういう恩恵があるのか、静的言語のプログラマじ...
自然言語の設計書とプログラムが一元管理されていてほしいと...
その手始めに、非プログラマにコメントの書き方を教えるとい...
例えば、
文章の先頭に // を付けましょう。以上。
こんな感じになります。
これはリンゴです。
↓
// これはリンゴです。
↑これだったらプログラマーじゃない人も10秒もあれば、コメ...
markdown形式は次に理解したらいいかもしれない。
理解しなくてもテキストが表現されるし、
理解していたら見栄えが良くなるし。
プログラムに依存してない。
もう少しプログラミングの知識のレベルが進んでもよいのなら...
// 用語の説明
class 用語名 {
}
ちょっと厳しいのか?
用語のグループ分けはpacageを使うよとか。
そこぐらいまでは、3分ぐらいで理解できるはず。
言葉のブレをなくしつつ、実装しやすい形式で残すことは、正...
IDEを使えば、数万とかの単語数も管理できる
なにがしたいかというと、
* markdown形式の中に 実際に動作するコードを入れておくア...
markdownのコメントの書き方に
``` 言語の指定
```
というのがある。
非プログラマにプログラムのコメント風に書いてね。だと通知...
何もプログラムを知らない人が書いたものは、プログラム化す...
コメントアウトの対象外は上記のmarkdownのコメントアウト指...
* コメントとソースコードがネガとポジのような関係を持つリ...
コメントリポジトリと、コードリポジトリを用意する。
ルールとしては、片方のリポジトリに変更があると、反転した...
** 反転ルール [#i5daa37b]
*** コメントリポジトリの反転ルール [#lc60c31b]
コミット時に
markdown形式は、Javaなど指定したコメント形式に反転する。
markdown形式で、Java としてコメント化されている場合は、そ...
*** ソースリポジトリの反転ルール [#pb2c9c40]
コミット時に
コメント部分は、markdown形式とする
Javaのコードはmarkdownのコメント形式とする
終了行:
この記事は、ただの思考実験です。
プログラマじゃない人に、EclipseなどのIDEによるサポートと...
そもそも、どういう恩恵があるのか、静的言語のプログラマじ...
自然言語の設計書とプログラムが一元管理されていてほしいと...
その手始めに、非プログラマにコメントの書き方を教えるとい...
例えば、
文章の先頭に // を付けましょう。以上。
こんな感じになります。
これはリンゴです。
↓
// これはリンゴです。
↑これだったらプログラマーじゃない人も10秒もあれば、コメ...
markdown形式は次に理解したらいいかもしれない。
理解しなくてもテキストが表現されるし、
理解していたら見栄えが良くなるし。
プログラムに依存してない。
もう少しプログラミングの知識のレベルが進んでもよいのなら...
// 用語の説明
class 用語名 {
}
ちょっと厳しいのか?
用語のグループ分けはpacageを使うよとか。
そこぐらいまでは、3分ぐらいで理解できるはず。
言葉のブレをなくしつつ、実装しやすい形式で残すことは、正...
IDEを使えば、数万とかの単語数も管理できる
なにがしたいかというと、
* markdown形式の中に 実際に動作するコードを入れておくア...
markdownのコメントの書き方に
``` 言語の指定
```
というのがある。
非プログラマにプログラムのコメント風に書いてね。だと通知...
何もプログラムを知らない人が書いたものは、プログラム化す...
コメントアウトの対象外は上記のmarkdownのコメントアウト指...
* コメントとソースコードがネガとポジのような関係を持つリ...
コメントリポジトリと、コードリポジトリを用意する。
ルールとしては、片方のリポジトリに変更があると、反転した...
** 反転ルール [#i5daa37b]
*** コメントリポジトリの反転ルール [#lc60c31b]
コミット時に
markdown形式は、Javaなど指定したコメント形式に反転する。
markdown形式で、Java としてコメント化されている場合は、そ...
*** ソースリポジトリの反転ルール [#pb2c9c40]
コミット時に
コメント部分は、markdown形式とする
Javaのコードはmarkdownのコメント形式とする
ページ名: