技術ドキュメンテーションのためのreStructuredTextとMarkdownを比較する | POSTD
Markdown と reStructuredText はどちらもマークアップ言語で、どのテキストエディタを使っても簡単に入力できるように設計されたプレーンテキスト形式構文です。どちらにもマークアップされたテキストをHTMLやPDFなどの出版形式に変換できるツールが多数あります。 これらのマークアップ言語は多くのドキュメンテーションシステムの基礎となるため、昨今のソフトウェア開発者はマークアップ言語をよく知っておく必要があります。この記事ではプログラマ視点でMarkdownとreStructuredTextのトレードオフを分析します。 Markdownが輝きを放つ場所 テキスト入力による豊富な書式設定で複雑なドキュメント構造を記述することができるマークアップ言語は長く輝かしい歴史を持っており、その歴史は少なくとも1970年代初めの troff とTeXまで遡ることができます。 これらの形式
わかりやすい README 駆動開発 - Qiita
巷には README 駆動開発（Readme Driven Development; RDD）なるものがあるようで、とても合理的でかつ便利であったので紹介します。 README 駆動開発（以下、RDD）とはその名の通り、README ありきの開発スタイルのことで、簡単に言うと「コード書く前に README 書く」ってことです。 開発に入る前にドキュメンテーション、というまあ当たり前であるようでちょっとしたツールでは蔑ろにしがちなことですよね。 わかりやすいREADME.mdを書く - SOTA Readme駆動開発を和訳してみた - Qiita Readme駆動開発を和訳してみた - 生涯未熟 実践的なREADME駆動について - GH Issue Note RDD のメリット モチベーションが高いときに書ける 正直、README 含めドキュメンテーションってめんどくさいです。しかし、コー
MSDN語パーフェクト文法マスター - Qiita
MSDN語とは こんなやつ。 いわゆる MSDN (と呼ばれていた) における日本語の言い回しのこと。 マスターすると何が嬉しい？ C# でドキュメント コメントを書く際に、標準ライブラリっぽくなります。 コメントのスタイルまで統一できるなんて、さすが C# は違う。 注意事項 2010 年代前半にまとめた文章を発掘して、そのままリリースしています。 すでに内容が古いかもしれません！
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
