これはこの質問をするのに理想的な場所ではないかもしれませんが、私は本当に行き詰まっており、他にどこに質問すればよいかわかりません (提案をいただければ幸いです)。
会社の C ライブラリ用に 4 つの新しい API の名前を考えようとしています。
これらの API は既存のセットに追加されているため、既に作成されたパターンと一致する必要があり、選択肢が制限されます。
すべての API (既存および新規) が行うことは、ユーザーがプログラムで使用される文字列または非文字列変数の値を取得/設定できるようにすることです。
私の違いは、既存のメソッドとは異なり、変数の名前を使用して値を取得できることです。
これが私が現在持っているものです:
VariableGetValueString
VariableSetValueString
VariableGetValue
VariableSetValue
これに関する唯一の問題は、変数の NAME を使用することが明確にされていないことです。これを顧客に明確に伝える、すっきりとした響きの名前は思いつきません。
できれば、他の API のパターンと一致するため、名前から何も削除しないようにする必要があります (これらの API は名前に検索方法を明示的に記載していませんが、これは無関係な理由でそうする必要があります)。
決定的な答えがないことはわかっていますが、明らかに最適なものを受け入れます。
これが質問をするのに不適切な場所である場合は申し訳ありませんが、より適切な場所があれば提案していただければ幸いです。
編集:
一部の既存の API 名は次のとおりです。
VariableGetTaskString
VariableGetTask
VariableGetGlobalString
VariableGetGlobal
それらの線に沿って。 変数のスコープを参照しますTask
。Global
そもそも名前がうまく付けられていなかったので、私の仕事は難しくなっていますが、顧客が慣れてきて古いプログラムが壊れてしまうため、変更することはできません。これらが提供する助けが少ないため、最初はこれらを含めませんでした(私の意見では)。
各 API のパラメーターは、それぞれが何をするのかを顧客に明らかにしますが、名前もそれを行うことが望ましいでしょう。ご意見をいただきありがとうございます。
編集2:
API への呼び出しの例を次に示します。
if(!VariableGetValueString(Handle handle, LPCSTR variableName, TaskID taskID, LPSRT value, DWORD bufferSizeinBytes)
{
//retrieve failed.
}
if(!VariableGetValue(Handle handle, LPCSTR variableName, TaskID taskID, PDWORD value)
{
//retrieve failed.
}
それが十分に明確であることを願っています。引き続きお気軽にお問い合わせください。一日中編集します。今後ともよろしくお願いいたします。