私は科学者であり、開発者に理解して別の言語でプログラミングするために、複雑なMatlabコードを文書化する必要があります。過去には、MS Word(プログラムの各ステップを表の新しい行として説明する)を使用してからExcelを使用しましたが、Matlabコードの表示や明確で簡潔なコメントの入力には特に適していませんでしたそれを文書化する方法。
疑似コードを開発者に伝えるためのより良い手法があるかどうか疑問に思っています。既存のソフトウェア(無料?)または他のプラットフォーム(例:TextWrangler)は、コードとその説明方法を提供するのに特に適していますか?同じことをしている他の人の経験から学びたいと思っています。前もって感謝します。
コメントを読んだ後、さらに説明してみましょう...私はすべての開発者が疑似コードを知っていると思いますが、多くの人がMatlabコードを知っているとは思いません。したがって、疑似コードで記述した場合、Matlabコードを無視できます(または参照用に提供するなど)。しかし、私の質問は本当に単純です...コードを開発者に明確に伝えるために人々が過去に使用したソフトウェアまたはプラットフォームはありますか?ドキュメントを作成する人がコードを簡単に説明できるようにするものはありますか?たとえば、ソフトウェアの色分けしたコード(コメントの1色、予約語(if、then、else、forなど)など)を埋め込むことができ、片側には説明を入力する余地があります参考文献など、MS製品を使用してこれを試しましたが、同じことをする必要がある人々の業界があるので、
%
コメントを開始することを知りたいので、Matlabコードに説明コメントを追加したいと思います。そして、私にとって意味のないことについての質問に戻りましょう。それはすべての周りで最も簡単でしょう。