generated at
文芸的プログラミング
ドキュメントコードを一緒に書く


目的
可読性を上げること?yosider
プログラマによってはコメントは最小限のほうが読みやすい説
場合によると思いますね 増井俊之
短くても、コメント無いと全く理解不可能なコードもありますし
認知能力が低いせいかもしれないけど、コメントがたくさんある方が読みやすいと感じるkuuote
ガンガンメモを書けばいいと思ってるし先日読んだ記事でもそんなことを言っている
ただ、コードに直接個人的な感情などを埋めたくない気持ちがあるので文芸的プログラミングで残しておきたい
コードコンプリートにコメントの書き方が載っている suto3
非常に乱暴に要約すると
コメントが必要ないソースコードを書け
必要なコメントを書け(不要なコメントは書くな)
ということ
情報の一体性を高めて保守の負担をへらす
>通常コンピュータのプログラミングでは、プログラムソースと関連するドキュメントを別々のファイルに記述するが、これには管理や更新内容の反映が負担となる。
> この問題に対して、文芸的プログラミングでは、ドキュメントとソースを併記したWEBと呼ばれるメタソースを記述し、そこからドキュメントとソースコードをそれぞれ生成させることで、情報の一体性を高めている(これらのメカニズムをWEBシステムと呼ぶ)。
Jupyter notebookや、JSDoc付きのコードから、ドキュメントを生成できるイメージyosider
もっと進んでいろんなものを一体化していく方向性
Scrapbox限定の目的
コメントをブラケティングする
Jupyter notebookに似てるbsahd


増井俊之さんのblog、UTF-8じゃなかった……
超古いからですね... すみません 増井俊之
まあ古い記事ですし、しょうがないですよtakker
未だにShift JISを使っているITmediaは許さん
技術系メディアとしてそれはどうなの…

増井俊之
マニュアルもヘルプもテストコードも一緒に書くのが良いと思う
自分とこのUserScriptで丁度それやってますtakker
いい話だ 増井俊之
ヘルプはなかった
> どんなIDEでもソースコード以外はオマケ扱いなのがよくないと思っています。ドキュメントマニュアルヘルプテストデモも同じところに書くべきであり、リンクも充実させるべきでしょうhttps://www.facebook.com/707202497/posts/10160098748742498/?d=n

試行錯誤の跡まで一緒に書いてしまうと可読性がさがる?
どうすれば解決するんだろう?
文芸的プログラミングと共同編集の組み合わせの前例がない以上、過去の事例を参考にできない……
すべてを同時に表示してしまうと空間的な限界があるので、viewを工夫する必要がありそうyosider

コードと散文を交互に書いてる本ってある?
技術書以外で
普通に小説で、普通にコードがしょっちゅう出てくる作品知りたい
あれば読みたい 増井俊之takker
なければ自分で書くしかないtakker
コードの代わりに数式がしょっちゅう出てくる作品ならあるtakker
数学ガールの話かな?kuuote
そうそれtakker
他にもいくつかあります

コードブロックだけ独立した物として編集できれば便利に使えそうだなと思うことはあるkuuote
プレーンテキストであることと両立するのは難しそう

プログラム書いてってお願いした時のLLMの出力も文芸的プログラミングの一つと思うmoeki