PHP NuSOAP 在函数中设置参数注释答案

【问题标题】：PHP NuSOAP set parameters comments in functionPHP NuSOAP 在函数中设置参数注释
【发布时间】：2014-04-27 05:28:36
【问题描述】：

我的代码运行良好，但我想为函数的参数变量设置一些 cmets。

$server->register(
    // method name:
    'getCustomerExists',         
    // parameter list:
    array('byWhat' => 'xsd:string'), 
    // return value(s):
    array(),
    $namespace,
    false,
    'rpc',
    'encoded',
    // description: documentation for the method
    'Retrieve customer by Email OR Identification Number.
     @byWhat = String'); 

function getCustomerExists($byWhat){
    return $web->getCustomerExists($byWhat);
}

对于这个测试，我使用的是 Visual C# Express。所以当我输入我的函数时，这就是弹出窗口的帮助：

除非人们阅读文档，否则他们不会知道“byWhat”是什么。

我正在寻找的是 Visual C# 在其函数中提供的参数注释。

我试过this solution 没有成功。

【问题讨论】：

标签： c# php soap comments nusoap

【解决方案1】：

您可以在您的 C# 代码中添加 cmets，它将显示为帮助文本：

/// <summary>
/// 
/// </summary>
/// <param name="someArgument">Description</param>
public void SomeMethod(string someArgument)
{

}

这里，“描述”将是名为 someArgument 的参数的帮助文本。

编辑，注意：

我刚刚意识到您似乎在谈论 Web 服务 - 如果是这样，这可能不适用。由于 Web 服务是由 XML 定义的，并且您用于客户端的代码是自动生成的，因此您的代码中的 cmets 将不包括在内。

愚蠢的黑客 PS：

您可能能够编辑生成的类，并在其中添加 cmets（这可以在 C# 中完成，我认为它也应该在 PHP 中工作），但除非您知道自己是永远不会更改或更新您的服务接口，这是一个非常糟糕的解决方案，因为：

它需要在生成的客户端代码上手动添加所有内容，并且
每次更新代码时，所有 cmets 都会消失。

【讨论】：