インプレス ビジネスメディア

Javadocから考える開発ドキュメンテーション

記事一覧

「どのように検証するのか」をJavadocで実現する

前回までのおさらい「Javadocが果たす役割とは」Javadocはソースコードとドキュメンテーションコメントからリファレンスドキュメントを作成するツールです。ソースコード中のクラス宣言やメ ソッド宣言と、それらの内容についての説明が書かれたドキュメンテーションコメントを、Javadocが解析して

足立 祐一

2007年9月4日 20:00

  • 設計／手法／テスト
  • 技術解説

「どんなシステムを作るのか」をJavadocで表現する

前回のおさらい「Javadocの基本」Javadocの機能は、ソースコード中の「/**」と「*/」で囲まれたドキュメンテーションコメントから、リファレンスドキュメントを生成することでした。ソースコードとドキュメンテーションコメントが一体になっているため、開発者は設計を考えながらソースコードを書き、

足立 祐一

2007年8月24日 20:00

  • 設計／手法／テスト
  • 技術解説

Javadoc、どのくらい活用していますか？

Java開発に役立つ「Javadoc」Javaで開発を行っていると、ライブラリのリファレンスとしてJavadocを参照することが多いはずです。ただ参照するだけでなく、場合によっては携わっているプロジェクトなどの開発規約でドキュメンテーション規約としてJavadocを記述することが定められているケー

足立 祐一

2007年8月17日 20:00

  • 設計／手法／テスト
  • 技術解説

人気記事トップ10

マニュライフ生命のAIの責任者にインタビュー。全社員がAIを使いこなすAI for Allとは？ 「Python 3.14.8」リリース ─ 緊急のアップデートリリース Kaggleは「加速」に役立つ ー挫折から戦略を立て直し、Kaggle Masterに至るまでの成長曲線 【見れば分かる。見ないと話せない】AIで作った成果物を、理解しているのか 「そのExcel、どこから持ってきたデータですか」――データブリックスがRow Zeroを買収、AIエージェントに触らせる前にガバナンスを効かせる 「MAX 26.6／Mojo 1.1.0」リリース ─ Mojoコンパイラーへの外部コントリビューションを受付 MySQLの「ST_Touches()」や「ST_Crosses()」などの8つの関数でジオメトリの位置関係を見比べてみよう LFがAIエージェントの動作証明仕様「TRACE」を受け入れ、KubeCon ChinaではCNCF史上初の3プロジェクト同時卒業、ほか 【クラウドネイティブ会議】最高のアラート通知とは何か ―― ノイズを減らし、対応につながる監視運用を考える 「Courier 2.0.8」リリース ─ ESMTP処理のクラッシュを修正
Kaggleは「加速」に役立つ ー挫折から戦略を立て直し、Kaggle Masterに至るまでの成長曲線 ゲームを作りながら楽しくスキルアップ！『ゲーム開発で学ぶC++入門 クリエイター直伝 創造力を高める知識と実践技法』を5名様にプレゼント！ インシデント対応の「経験値」と「勘」はどこで育つのか 塩漬けの基幹システムを、誰が読み解くのか――NSSOLがAnthropicと提携、Claude Codeでレガシー移行に挑む 【見れば分かる。見ないと話せない】AIで作った成果物を、理解しているのか Meta、新型VRデバイスや新型AIグラスを多数発表 ほか AIがコードを量産する時代、「テストする人」はどう変わるか ――Tricentis Japanが語る品質保証の現在地 MagicPodのエバンジェリスト伊藤由貴さん 「MX Linux 25.3」リリース ─ Debian 13.7までの更新を反映 「Proxmox VE」のリポジトリ構成を理解してホストをアップデートしよう
ゲームを作りながら楽しくスキルアップ！『ゲーム開発で学ぶC++入門 クリエイター直伝 創造力を高める知識と実践技法』を5名様にプレゼント！ 「Ubuntu 26.04.1 LTS」リリース ─ 8月25日までのアップデートを反映 「Kotlin」の「Swing」「Java2D」でデスクトップゲーム「Color」を開発してみよう Kaggleは「加速」に役立つ ー挫折から戦略を立て直し、Kaggle Masterに至るまでの成長曲線 「イチゴと会話しろ」と言われたIT起業家が見つけた、農業の構造的課題 AIの書いた非同期処理は、なぜ実機で遅いのか 欧州CRA対応とSBOM運用。AI生成コードのOSS混入問題の対策とは ――スニペット単位で検出する「FossID」「Insignary Clarity」によるSBOM運用 Kaggleは「今いる場所で成長する」のに役立つ ー社内コンペ・育成制度・会場提供、DSが組織を動かすまで PostgreSQLからTiDBへ、稼働中SaaSで進める段階的DB移行の実践と再設計への展望 【AIエージェント時代の新資格】AIエージェント・ストラテジストから見える「これから求められる人材」
人気記事ランキングをもっと見る

新着記事

MySQLの「ST_Touches()」や「ST_Crosses()」などの8つの関数でジオメトリの位置関係を見比べてみよう 10月2日 6:30 マニュライフ生命のAIの責任者にインタビュー。全社員がAIを使いこなすAI for Allとは？ 10月2日 6:00 ゲームを作りながら楽しくスキルアップ！『ゲーム開発で学ぶC++入門 クリエイター直伝 創造力を高める知識と実践技法』を5名様にプレゼント！ 10月1日 10:00 【見れば分かる。見ないと話せない】AIで作った成果物を、理解しているのか 10月1日 6:30 「そのExcel、どこから持ってきたデータですか」――データブリックスがRow Zeroを買収、AIエージェントに触らせる前にガバナンスを効かせる 10月1日 6:25

企画広告も役立つ情報バッチリ！ Sponsored

欧州CRA対応とSBOM運用。AI生成コードのOSS混入問題の対策とは ――スニペット単位で検出する「FossID」「Insignary Clarity」によるSBOM運用 9月16日 6:40 PostgreSQLからTiDBへ、稼働中SaaSで進める段階的DB移行の実践と再設計への展望 9月7日 6:30 機能安全開発におけるGoogleTestの活用を支援!「Parasoft C/C++test CT」で実現する効率化＆AI連携 4月14日 6:30 【CNDW2025】Grafanaが明かす「オブザーバビリティの哲学」ー最小限の労力で実用的なインサイトを得るには 1月23日 6:30 【CNDW2025】プロダクト急増に備える基盤刷新 ーウェルスナビがECSからEKSへの移行で得た知見とは 1月15日 6:30 【CNDW2025】250環境を5人で運用、構築時間は30分に ーKINTOテクノロジーズが語るインフラ基盤組織の作り方 2025年12月18日 6:30 新たな自動化で熱視線！ AIエージェントの「推論能力」を支える2つのコンポーネントとは？ 2025年11月28日 6:30 IoTに生成AIを掛け合わせる「AI-driven IoT」で現場のIoTデータ活用を加速 2025年11月26日 6:30 アイレット、KDDIの属人化問題を生成AIアシスタントの精度を高め解消へ 2025年11月21日 6:30 「Grafana Cloud」の先進的ユーザーであるグリーが10年をかけて到達した「オブザーバービリティ」とは 2025年5月15日 6:30