アカウント名:
パスワード:
DB設計書とか通信インタフェースとかUIとか色々ありますからね。ソースコードのコメントで表現が難しい/できなのも多いのでは。
> しかし、自動出力したドキュメントは「上司がわからないから」として却下された。
これもメソッドやクラスの(javadoc的な)物であればコードに触れない層にわからないだろうし、もっと上流の業務寄りな文書って必要だと思う。
DB 設計書って言っても、Excel の表にフィールド並べて1行コメントしてあるだけってレベルの多いしそのレベルで問題ないなら SQL にコメント入れとけば十分だって
一番書きたいcreate tableなんて、管理しているソースではカンマで複数行にしているけど、丸括弧の中は一行で、マイナスマイナスから始まる行コメントを書くとエラーなのでは?
どう書けば良いのでしょう?
ソースコードのコメントを抜いて、COMMENT を追加するスクリプト通せばいいだけじゃない?
少なくとも PostgreSQL、SQLite3 に関しては-- は C/C++ で言うところの行末までの1行コメント // なので
---------------------------------------create table hoge (id text, -- user idpw text -- user password);---------------------------------------
のような書き方は出来ますよ。
より多くのコメントがこの議論にあるかもしれませんが、JavaScriptが有効ではない環境を使用している場合、クラシックなコメントシステム(D1)に設定を変更する必要があります。
犯人は巨人ファンでA型で眼鏡をかけている -- あるハッカー
設計書と一言で言っても (スコア:3, 興味深い)
DB設計書とか通信インタフェースとかUIとか色々ありますからね。ソースコードのコメントで表現が難しい/できなのも多いのでは。
> しかし、自動出力したドキュメントは「上司がわからないから」として却下された。
これもメソッドやクラスの(javadoc的な)物であればコードに触れない層にわからないだろうし、もっと上流の業務寄りな文書って必要だと思う。
Re: (スコア:0)
DB 設計書って言っても、
Excel の表にフィールド並べて1行コメントしてあるだけってレベルの多いし
そのレベルで問題ないなら SQL にコメント入れとけば十分だって
Re:設計書と一言で言っても (スコア:0)
一番書きたいcreate tableなんて、
管理しているソースではカンマで複数行にしているけど、
丸括弧の中は一行で、マイナスマイナスから始まる行コメント
を書くとエラーなのでは?
どう書けば良いのでしょう?
Re:設計書と一言で言っても (スコア:1)
ソースコードのコメントを抜いて、COMMENT を追加するスクリプト通せばいいだけじゃない?
Re: (スコア:0)
少なくとも PostgreSQL、SQLite3 に関しては
-- は C/C++ で言うところの行末までの1行コメント // なので
のような書き方は出来ますよ。