Common Lispのライブラリのドキュメント化された整理されたコレクションはありますか?
-
08-07-2019 - |
質問
私は、主にJavaを教える学校の大学生です。 Javaの長所の1つは、私が非常に楽しんでいるが、ライブラリの大規模なコレクションです。これらのライブラリが特に役立つのは、JavaDocを介して提示される広範なドキュメントと構成です。 Common Lispにもこれらの品質を備えたライブラリコレクションがあり、これらのライブラリの構築、保守、または拡張を支援するJavaDocに似たツールはありますか?
解決
いいえ、包括的で一貫して文書化されたライブラリコレクションはありません。そのようなものが存在しないことは、現在Common Lispの最大の問題です。 Lispコミュニティを支援することに興味があるなら、これが最初に攻撃することになるでしょう。
また、 JavaDocに相当するものはありますが、広く受け入れられている準標準はありませんJavaの場合。
他のヒント
はい>、 http://www.cliki.net および http://clocc.sourceforge.net 。また、高度な「asdf」または「mk-defsystem」ベースインフラストラクチャを使用してそれらを使用します。
quicklispが追加され、すべてが非常に簡単になりました! http://www.quicklisp.org/
Github には、 Sourceforge
clikiまたはcommon-lisp.netを試してください。
javadocについて... docstringについて知っていますか?そうでない場合は、調べてください。他のすべての自己文書化機能についても調べてください。
仕様を読んでいないようです。何をしていても、常に仕様を読んでください。
clbuild をお勧めします。これには、経験豊富なグループによってコンパイルされた品質ライブラリのコレクションが含まれています、目の肥えたLispプログラマー(およびこれらのライブラリーをダウンロードしてインストールするスクリプト)。
highlevel / apiドキュメント作成のガイドラインが必要な場合は、Edi Weitzなどが設定した例に従うことをお勧めします(たとえば、 Hunchentoot 、 Vecto )。
低レベルの実装ドキュメントについては、組み込みのdocstringメカニズムと Slime のソースナビゲーションおよびautodoc機能は、コード探索のための既存の最適な環境を構成します。
Tinna は、JavaDocに匹敵するLispドキュメントシステムです。
Common Lispには多くの利用可能なライブラリがあり、それらの多くは徹底的に文書化されています。私自身の経験では、JavaDoc(またはDoxygen for C ++のようなツール)はライブラリを文書化するための貴重なツールではなく、その実装を文書化するためのツールです。
ドキュメントはここではツールの問題ではなく、まともなマニュアルを書くためのlibの作者の意志によるものです。この分野では、Common Lispは他の言語と同じです。素晴らしいドキュメント、ドキュメントのわずかな兆候のない素早い汚いコード、そしてコードとドキュメントの品質のあらゆる可能な組み合わせを備えた美しいエンジニアリング部分があります...
全体として、Common Lispライブラリの全体的な品質はかなり高いことが個人的にわかった。
Javaに慣れている場合は、 Clojure にチャンスを与え、知っているJavaライブラリを使い続けることができます。