basyura's blog

あしたになったらほんきだす。

エンジニアのためのJavadoc再入門講座 現場で使えるAPI仕様書の作り方 - 佐藤竜一

book

エンジニアのためのJavadoc再入門講座 現場で使えるAPI仕様書の作り方

エンジニアのためのJavadoc再入門講座 現場で使えるAPI仕様書の作り方

Amazon
★★★☆☆
以前は HTML に起こす事を考えてちょっと頑張ってみたりしてたけど、ソースの数が膨大になったのもあって HTML を起こす事を意識して書く事は無くなってしまった。
製品としていろんな人がみるならまだしも SI で個別に作ってるものに対してみんなどれぐらい力を入れて作ってるんだろうか？僕の場合はもう

/**
* ○○するメソッドです。
* これは○○で△△であるため××です。
* 使いかたは
*   A a = new A();
*   a.method();
*
*/
public void method() {

こんな感じでソースを開いてみる事を前提に書いちゃってる状態。本書に

クリアなコードを書くためには、コードもドキュメントの一つとして真剣に扱う必要がある

とあったのでちょっと考えを改めようと思う今日この頃。
パターン別にチェックポイントがあって、どう書けばいいのかが載っているので一読してみた方が良いと思う。
最後は Contact4J5 の説明で何となく終わった感じなのがちょっと残念ではあった。

Sequel: The Database Toolkit for Ruby (v3.7.0)

ruby sequel

なんとなく和訳してみる

Sequel provides thread safety, connection pooling and a concise DSL for constructing database queries and table schemas.

Sequel: The Database Toolkit for Ruby (v3.7.0)

スレッドセーフなコネクションプーリングとDB 並びにテーブルスキーマを容易に構築するための DSL を提供します。

Sequel also includes a lightweight but comprehensive ORM layer for mapping records to Ruby objects and handling associated records.

Sequel: The Database Toolkit for Ruby (v3.7.0)

軽量ですが、Ruby オブジェクトへの変換や関連レコード操作のための ORM が組み込まれています。

Sequel supports advanced database features such as prepared statements, bound variables, stored procedures, master/slave configurations, and database sharding.

Sequel: The Database Toolkit for Ruby (v3.7.0)

プリペアドステートメント・束縛変数・ストアドプロシジャ・マスタ/スレーブ構成・database sharding といった先進的な機能をサポートしています。

Sequel makes it easy to deal with multiple records without having to break your teeth on SQL.

Sequel: The Database Toolkit for Ruby (v3.7.0)

SQLで苦労することなく複数のレコードを扱う事ができます。

Sequel currently has adapters for Amalgalite, ADO, DataObjects, DB2, DBI, Firebird, Informix, JDBC, MySQL, ODBC, OpenBase, Oracle, PostgreSQL and SQLite3.

Sequel: The Database Toolkit for Ruby (v3.7.0)

Amalgalite, ADO, DataObjects, DB2, DBI, Firebird, Informix, JDBC, MySQL, ODBC, OpenBase, Oracle, PostgreSQL, SQLite3 のアダプタが有ります。