タグ

Javaとdocumentationに関するraimon49のブックマーク (9)

  • APIデザインにおける七つの大厄介 | POSTD

    (編注:2016/7/29、頂いたフィードバックを元に記事を修正いたしました。) APIをデザインするということは、科学であり技術でもあります。多くの頭の良い人たちが失敗を重ねてきました。成功している人たちは、APIの主な目的を念頭においてデザインしているのです。その目的とは、「開発者たちをウンザリさせる」ということです。 親愛なる仲間たち、その崇高っぽい追求を称えるべく、「APIデザインにおける七つの大厄介」を共に数え上げようではありませんか(私がしたことを見てください)。 リスティクル(箇条書き形式の記事) を書くつもりはないのですが、少なくともタイトルは 教養ある宗教的文献が参照元 です。 まず、ルールを決めましょう。ここでは、成功し、きちんと機能しているAPIを取り上げます。ですから、「動かない」とか、「大量のセキュリティホールがある」といったことは厄介ごとに数えません。「致命的」

    APIデザインにおける七つの大厄介 | POSTD
    raimon49
    raimon49 2016/03/10
    1つの概念を示す別名が多過ぎると云うのは凄く実感するところ。
  • Java版Foundationのこと、覚えてる? - なるようになるかも

    qiita.com 素朴な疑問があったので投稿してみました。これはその補足みたいなもの。 CoreData CoreDataって凄く独特な世界観を持っていて扱いづらいと思った人が多いのではないでしょうか。 なんでこんなのがXCodeやInstrumentsのテンプレートに居座っているのか理解できない、関連張ると動作が重くなりすぎて使い物にならない、CoreData内部の良く分からないエラーに悩まされている、普通にSQL書きたいからFMDB使ってます、幻滅しましたRealmに移行します、そんな雰囲気だと思います。 CoreDataの原型は、NeXTのFoundationが用いられた最初の製品であるEnterprise Objects Frameworkです。 20年前にデータベース製品の学習コストの高さと、オブジェクト指向言語とのインピーダンスミスマッチの問題に取り組んだこの製品は、普及はし

    Java版Foundationのこと、覚えてる? - なるようになるかも
  • Javadoc ドキュメンテーションコメントの書き方 - Qiita

    そもそも、そのメソッドの作成者が近くにいない場合、こういった確認すら行えません。結局、あるメソッドを使うために、そのメソッドの実装を時間をかけて分析することになるため、複数人で開発していることが、逆に開発効率を悪化させてしまいます。つまり、簡単に言うと、 「仕様の明確でないメソッドを作るのは迷惑行為です!」 ドキュメンテーションコメントによって API 仕様が明確にされていれば、こういった無駄なやりとりがなくなるため、開発効率もコード品質も上がります。下記のグラフは、開発メンバの人数と、生産性の関係を表しています。 仕様の不明確な API が溢れているプロジェクトに新しい実装メンバを投入しても、開発効率はうまく上がっていきません。すべての API の仕様が明確になっていれば、不具合が見つかった場合でも、各メソッドが何を実現すべきかが分かるので、別の人が実装を引き継いで修正していくことが可能

    Javadoc ドキュメンテーションコメントの書き方 - Qiita
    raimon49
    raimon49 2015/01/01
    nullをどう扱うか、スレッドセーフか
  • ホーム: Java Platform, Standard Edition (Java SE) 8リリース8

    Oracle | Hardware and Software, Engineered to Work Together

    ホーム: Java Platform, Standard Edition (Java SE) 8リリース8
  • GoogleのJavaコーディング規約

    Spring BootによるAPIバックエンド構築実践ガイド 第2版 何千人もの開発者が、InfoQのミニブック「Practical Guide to Building an API Back End with Spring Boot」から、Spring Bootを使ったREST API構築の基礎を学んだ。このでは、出版時に新しくリリースされたバージョンである Spring Boot 2 を使用している。しかし、Spring Boot3が最近リリースされ、重要な変...

    GoogleのJavaコーディング規約
    raimon49
    raimon49 2014/02/21
    Googleって2 spacesインデント好きだよね。他言語のスタイルガイドでも出て来る。
  • https://blog.ik.am/entries/138

    raimon49
    raimon49 2012/06/19
    すごい(が、全部満たせる自信が無い)
  • さよならsun.comのつづき 2012-03-26 - marsのメモ

    (追記)日Javadocが従来通りオンラインで参照できるようになったようです。 → 続:旧 Java SE API リファレンスへの新しいリンク先変更について | 寺田 佳央 - Yoshio Terada それでも、oracle.comから探しに行くと見つからないので気をつけてね(日Javadocは、日オラクルの管理なんだそうな。 java.sun.comにアクセスできなくなる事について、ちょっと気になることがあったので寺田さんに聞いてみました。 なるほど、whoisでsun.com調べてみると"Record expires on 20-Mar-2017"だし、確かに java.sun.com にアクセスするとwww.oracle.com/technetwork/java/ にリダイレクトされる。 とりあえず、次のURIは見えるのを確認しました(でも、なんか不安定なのよね。 h

    さよならsun.comのつづき 2012-03-26 - marsのメモ
    raimon49
    raimon49 2012/03/27
    xsdはリダイレクトされる
  • 新しい Java SE API リファレンスの入手先について

    新しい Java SE API リファレンスの入手先について 2012年3月25日 at 10:30 午後 3件のコメント 2012 年 03 月 25 日、sun.com のドメインが利用不可になりました。これに併せ、java.sun.com で提供されていた Java SE API語ドキュメントもオンライン経由で参照する事ができなくなりました。今後、日語の Java SE API レファレンスはオンライン経由では参照できなくなりますので、アーカイブを御入手の上、ローカル環境でご参照ください。お手数をお掛けし申し訳ございませんが、どうぞ宜しくお願いします。 Java API の日語ドキュメントはコチラから入手が可能です。 ドキュメントの再配布ポリシーはコチラをご参照ください。 新しい日API ドキュメントのオンライン参照先URL (2012/4/11 訂正、追記) htt

    新しい Java SE API リファレンスの入手先について
    raimon49
    raimon49 2012/03/26
    これくらいはドメイン維持してくれても良かったんじゃ。
  • いまさら聞けない「Javadoc」と「アノテーション」入門

    いまさら聞けない「Javadoc」と「アノテーション」入門:【改訂版】Eclipseではじめるプログラミング(22)(1/4 ページ) これからプログラミングを学習したい方、Javaは難しそうでとっつきづらいという方のためのJavaプログラミング超入門連載です。最新のEclipseとJava 6を使い大幅に情報量を増やした、連載「Eclipseではじめるプログラミング」の改訂版となります 注釈とコメントで開発しやすくしよう 開発者がソースコードにコメントを自由に記述すると、統一性がなくなり、同じ内容をさまざまな表現で書いてしまいます。これを防ぎ、重要な情報について統一的な表現で記述したいときは、「アノテーション(annotation、注釈)」を使うことを検討してみましょう。 Javaではアノテーションをプログラムのソースコードへプログラムのメタデータとして記述できます。また、プログラムにア

    いまさら聞けない「Javadoc」と「アノテーション」入門
  • 1