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

Question

我的代码效果很好，但我想对函数的参数变量设置一些注释。

$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。所以当我输入我的函数时，这就是弹出窗口的帮助：

除非人们阅读文档，否则他们不会知道＆＃34;通过什么＆＃34;是。

我正在搜索的是Visual C＃在其功能中给出的参数注释。

我试过this solution但没有成功。

Answer 1

您可以在C＃代码中添加注释，这些注释将显示为帮助文本：

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

}

在这里，＆＃34;描述＆＃34;将是名为someArgument的参数的帮助文本。

编辑，注意：

我刚刚意识到你似乎在谈论一项网络服务 - 如果是这样，这可能不适用。由于Web服务是由XML定义的，并且您自动生成用于客户端的代码，因此不会包含代码中的注释。

傻傻的PS：

你可能能够编辑生成的类，并在那里添加注释（可以在C＃中完成，我认为它也应该在PHP中工作），但除非你知道你是永远不会改变或更新您的服务界面，这是一个非常糟糕的解决方案，因为：

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