apiDoc - Inline Documentation for RESTful web APIs
apiDoc creates a documentation from API annotations in your source code. Java, JavaScript, PHP, … CoffeeScript Elixir Erlang Perl Python Ruby Lua /** * @api {get} /user/:id Request User information * @apiName GetUser * @apiGroup User * * @apiParam {Number} id Users unique ID. * * @apiSuccess {String} firstname Firstname of the User. * @apiSuccess {String} lastname Lastname of the User. */ ### @api
Swiftでヘッダドキュメント - tsntsumi’s NOOTO
メソッドや関数のヘッダコメントに、その説明を書くのは JavaDoc 以前からよく行われていたドキュメンテーションの方法ですが、Swift では JavaDoc スタイルの記述方法がうまく働かなくなっていました。「@param」や「@return」が認識されないのです。 これ、「@param」ではなく「:param:」、「@return」ではなく「:returns:」だと認識してくれるみたいです。 (参考: http://nshipster.com/swift-documentation/ ) ただし、Description と :param: の行の間には空行を挟む必要があるようです。 また、リストも行頭に「-」または「+」をつければ、簡単にかけるようです。 コメントも「/**」「*/」で囲む方法ではなく、行頭に「///」でもよいようです。 追記: 番号付きリストや、定義リスト、ブロック
Swift Documentation
Written by Nate Cook & Mattt July 11th, 2018 (revised) This article has been translated into: 中文 Code structure and organization is a matter of pride for developers. Clear and consistent code signifies clear and consistent thought. Even though the compiler lacks a discerning palate when it comes to naming, whitespace, or documentation, it makes all the difference for human collaborators. This week
Ruffnote (ラフノート)
文書管理ツール「Ruffnote (ラフノート)」は、添削や履歴管理、共同編集などを全てクラウド上で行うことができます。
Pandoc - index
If you need to convert files from one markup format into another, pandoc is your swiss-army knife. Pandoc can convert between the following formats: (← = conversion from; → = conversion to; ↔︎ = conversion from and to) Lightweight markup formats ↔︎ Markdown (including CommonMark and GitHub-flavored Markdown) ↔︎ reStructuredText → AsciiDoc ↔︎ Emacs Org-Mode ↔︎ Emacs Muse ↔︎ Textile → Markua ← txt2t
OpenID Foundation Japan - 翻訳・教育 Working Group
OpenID Foundation Japan 翻訳・教育 Working Group は、OpenID Foundation Japan 参加メンバーを中心に、有志により運営されています。現在は主に OpenID & OAuth 関連仕様書の翻訳活動を行っています。 翻訳ドキュメント一覧 OpenID 認証は、エンドユーザが識別子 (Identifier) を管理していることを証明する方法を提供するものである。OpenID 認証を利用すれば、リライングパーティー (Relying Party、以下 RP) はエンドユーザのパスワードやメールアドレスなどにアクセスする必要がなくなる。 OpenID Attribute Exchange は、エンドポイント間で属性情報を交換するための OpenID の拡張仕様である。ユーザーの属性情報を更新または取得するためのメッセージを提供する。 Open
PostgreSQL Internals
本コンテンツは、2014年1月30～31日に筑波大学で開講された「情報システム特別講義D」における講義「Inside PostgreSQL Kernel」の内容を再構成、加筆・修正したものです。 はじめに 本コンテンツについて 本コンテンツへのフィードバックについて アーキテクチャ概要 PostgreSQLの構成要素 PostgreSQLの基本的なアーキテクチャ SQL文の処理される流れ トランザクション管理 トランザクション処理におけるACID特性 各レコードの可視性の管理 Atomicity（原子性）の実装 Consistency（一貫性）の実装 Isolation（分離性）の実装 トランザクション分離レベルの定義 Durability（永続性）の実装 チェックポイント メタデータ管理 pg_controlファイル OID/XID/TID システムカタログ MVCCとストレージ構造 テ
CloudConvert
File Converter CloudConvert is an online file converter. We support nearly all audio, video, document, ebook, archive, image, spreadsheet, and presentation formats. To get started, use the button below and select files to convert from your computer.
GitHub - tomaz/appledoc: Objective-c code Apple style documentation set generator.
IMPORTANT NOTICE: collaborators needed appledoc is command line tool that helps Objective-C developers generate Apple-like source code documentation from specially formatted source code comments. It's designed to take as readable source code comments as possible for the input and use comments as well as surrounding source code to generate visually appealing documentation in the form of HTML as wel
sips(1) Mac OS X Manual Page
Retired DocumentImportant: This document may not represent best practices for current development. Links to downloads and other resources may no longer be valid. IntroductionThis document describes how to use the HeaderDoc tool. It also explains how to insert HeaderDoc comments into your headers and other files. This document corresponds with HeaderDoc 8.0. For information about previous versions,
はやわかり reStructuredText
本マークアップ記法の完全な詳細は reStructuredText のページに示されています。このテキストは、覚書としての性格の文書です。 "(詳細)" というリンクを辿ると reStructuredText 仕様書を参照できます。 ただし、相対リンクとなっていますので、リンク切れの場合は、 原版の "Quick reStructuredText" から参照してください。 目次 インライン マークアップ バックスラッシュによるエスケープ 章立ての構造 段落 記号つきリスト 番号つきリスト 定義リスト フィールドリスト オプションリスト 整形済みブロック ラインブロック 引用 Doctestブロック 表 区切り線 明示的マークアップ 脚注 出典 リンクターゲット 外部ターゲット 内部ターゲット 間接ターゲット 暗黙ターゲット ディレクティブ 代入参照とその定義 コメント 助けを得たい場合は
Quick reStructuredText
Quick reStructuredText https://docutils.sourceforge.io/docs/user/rst/quickref.html Being a cheat-sheet for reStructuredText Updated $Date: 2022-01-29 23:26:10 +0100 (Sa, 29. Jän 2022) $ Copyright: This document has been placed in the public domain. The full details of the markup may be found on the reStructuredText page. This document is just intended as a reminder. Links that look like "(details)
Overview — Sphinx v1.0 (hg) documentation
ダウンロード このドキュメントはバージョン1.0 (hg)のためのものです。まだリリースされていません。 Mercurialリポジトリのコードを利用するか、Python Package Indexにあるリリースバージョンを探してください。 疑問? 意見? Googleグループへの参加: もしくは、FreeNodeの#python-docsチャンネルへどうぞ 何か気づいたことがあれば、issue trackerを使用して通知することもできます。 Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。 このツールはもともと、新しいPythonのドキュメントの変換のために作られました。そして、今までに数々のPythonや、他の言語で開発されているプロジェクトに対して、すばらしいドキュメンテーシ
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - mixi-inc/AndroidTraining: Training course repository for android app development
GitHub - mixi-inc/iOSTraining: Training course repository for iOS app development
GitHub - hyde/hyde: A Python Static Website Generator (See https://duct-ui.org from the author).
Welcome to Lumache’s documentation! — Lumache 0.1 documentation
developerWorks Open source projects 日本語記事一覧
Client Challenge
はてなブログ | 無料ブログを作成しよう
