More than 1 year has passed since last update.


ドキュメントコメントについて

プログラミングのサンプルソース等には<summary>や@が付けられた、

謎の書式による関数やクラスの概要が記述されていることが多い。

その正体は媒体により呼び名は異なるが、ドキュメントコメントなどと言われるもののようだ。

これは、読んでそのままに関数やクラスのドキュメント用のコメントであるが、

一定の書式に収めることで、エディタで自動で型を保管してくれたり、

インテリセンスでの説明文として、

またはドキュメントの自動生成などで使用できるようになる。

近いうちにもう少し触りこんでみたい。


各言語の書式とかのリンク(興味ある言語だけ)


Visual C++ (ドキュメント コメント)

https://msdn.microsoft.com/ja-jp/library/ms177246.aspx


C# (ドキュメント コメント)

https://msdn.microsoft.com/ja-jp/library/5ast78ax.aspx

http://dobon.net/vb/dotnet/programing/xmldocument.html


VisualBasic (ドキュメント コメント)

https://msdn.microsoft.com/ja-jp/library/ms172652.aspx

https://msdn.microsoft.com/ja-jp/library/aa289191(v=vs.71).aspx

http://dobon.net/vb/dotnet/programing/xmldocument.html


JavaScript (JSDoc)

https://msdn.microsoft.com/ja-jp/library/mt162307.aspx

https://ics.media/entry/6789


Python (ドキュメンテーション文字列、docstring)

http://trivial-contents.com/programming/python/pydoc.html

http://h-miyako.hatenablog.com/entry/2014/11/11/072309

http://qiita.com/methane/items/e95c578c3d8fc5f1f62e


CommonLisp

http://tips.cddddr.org/common-lisp/index.cgi?%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%86%E3%83%BC%E3%82%B7%E3%83%A7%E3%83%B3

http://sile.hatenablog.jp/entry/20100124/1264260951


HSP (hs ドキュメンテーションコメント)

http://www.onionsoft.net/hsp/v34/doclib/HSP%20Document%20Library/hdl_usage.htm

http://www.onionsoft.net/hsp/v35/doclib/HSP%20Document%20Library/HS_BIBLE.txt

※ファイルのエンコードは要Shift-JIS & CRLFであること


D言語

http://www.kmonos.net/alang/d/ddoc.html