問題タブ [code-documentation]

私はColdFusionを使用してかなり大規模な新しいプロジェクトを開始しています。この新しいプロジェクトには複数の開発者が含まれるため、コードのドキュメントが重要になります。

（適切なコードドキュメントまたは他のツールを使用して）回避したいもう1つの問題は、コードの重複です。ここでは、検索や図表化のためにコードに「インデックスを付ける」ことができるツールが役立つでしょう。

特にColdFusionまたは言語に依存しないために使用している他のものは何ですか。違いが生じる場合は、基盤となるフレームワークにColdBoxを使用する可能性があります。

すべての提案をありがとう。

-c

PHPdoc を使用して、関数またはオブジェクト メソッドによって返されるオブジェクト プロパティを定義できるかどうかを調べようとしています。

次のクラスがあるとします。

これで、入力パラメーターを簡単に定義できるようになりました。

問題は、問題のメソッドによって返される (stdClass の) 出力オブジェクトのプロパティを定義するための同様のものがあるかどうかです。別のプログラマーがこのクラスを開いてメソッドを手動で調べて、戻りオブジェクトが何を返しているかを確認する必要がないようにするには?

FiM ++プログラムの構造では、特定の方法で文字とコード作成者の名前を閉じることで終了する必要があります。

言語仕様によると、キーワード「あなたの忠実な学生」（コンマを含むが、次のスペースは含まない）がクラス定義の終了タグとして使用され、次の名前は構文上の影響のないコメントです。

著者がすべてのファイルに自動的に含まれているという事実（厳密に必要とされていない場合）は、Javaドキュメントに似た解釈可能なドキュメントの形式として使用できるかどうか疑問に思います。言い換えれば、他のプログラムや編集者はこの名前を解析して、何らかの方法で使用することができます。

1. そのような内部コメントベースのドキュメントの要件は何ですか？この特定のタイプの構文に問題を引き起こすものはありますか？

2. キーワードはテーマに合うのに十分ですか？「あなたの忠実な学生」を複数形で使用する能力がない場合（または、あいまいなバージョンの場合は「あなたの忠実な」または「あなたの真の」）、複数の著者のリストが不自然で不自然に見えることがあります（そして、自然な人間が書いた手紙のように見えることは、コアデザインパラダイムの1つです）。

3. Java Docs方法論の作成を検討した場合、他にどのような機能を含める必要がありますか？一つには、日付は一般的なようです。手紙の上部に何らかの形の日付コメントを含めると、おそらく自然に見え、設計パラダイムに反することはありません。

言語は新しく、ほとんどの人にはなじみがなく、正直なところ非常にばかげているので、考慮すべきいくつかのリソースがあります。

オリジナルリリースのお知らせ

10月のフォローアップ

私は現在、基本的にスプレッドシートをデータベース オブジェクトとして扱う Google Apps Script のライブラリを開発しています。

現在、ライブラリには次のような2つの同一の機能があります

現在、2 つのパブリック関数について、生成されたドキュメントには戻り値の型のみが示され、パラメーターや添付された命令は示されていません。これは Google の問題であり、あまり気にしていないと思います。

しかし、私の主な質問はこれです。関数はプライベート関数からオブジェクトをインスタンス化しているため、そのオブジェクトに存在するメソッドを表示する自動ドキュメントを取得するにはどうすればよいですか。すべての機能はオブジェクトによって提供され、GAS がオブジェクトのメソッドを表示できれば素晴らしいことです。

ノート

メソッドはすべて関数のプロトタイプに配置されます。例えば。

ありがとう。

質問が単純で申し訳ありませんが、Appledocs ( https://github.com/tomaz/appledoc#quick-install )を使用してドキュメントを生成しようとしていました。

正確に設定する方法がわかりません。私がそれを行う方法は次のとおりです。

• github リポジトリのクローンを作成し、ターミナルでインストール スクリプト(appledocs --help を使用してこれを確認します) を使用して appledocs をインストールします。

ただし、xcode で自分のプロジェクトを持っているという意味で、これを実際にどのように使用すればよいでしょうか。

• ドキュメント ファイルを生成する方法
• どこで生成されますか？

Python インタープリター内で:

私が持っているパッケージについて知るには、どのような方法がありますか?

SyntaxError: 無効な構文

訂正:

さて、sys.path で利用可能なすべてのパッケージを確認するにはどうすればよいでしょうか? その後の使用方法とドキュメントを参照してください。PDF を簡単にダウンロードできることはわかっていますが、これらはすべて既に組み込まれているため、ファイルを複製したくありません。

ありがとう！

>>>ソースコードでよく見かけますが、 が何をするのか理解できませんでした。