如何在VS2022的ASP.NET WebForms中获取PageMethods/WebMethods的JS智能提示？

下面是几个实用的解决办法，帮你摆脱"魔法字符串"困境，获得方法签名提示：

1. 生成强类型声明文件（TypeScript/JSDoc） #

如果用TypeScript，根据服务器端WebMethod的签名，手动编写.d.ts声明文件：

declare namespace PageMethods {
    // 对应服务器端的Foo方法，按实际参数/返回值类型调整
    function Foo(val1: string, val2: number, onSuccess?: (result: string) => void, onFailure?: (error: any) => void): void;
    // 其他WebMethod同理添加
}

把这个文件放在项目根目录或VS能识别的类型声明目录下，编辑器会自动加载，提供Intellisense。

如果用纯JavaScript，给PageMethods添加JSDoc注释：

/**
 * 调用服务器端Foo方法
 * @param {string} val1 - 第一个参数
 * @param {number} val2 - 第二个参数
 * @param {function(string)} [onSuccess] - 成功回调，参数为返回结果
 * @param {function(any)} [onFailure] - 失败回调，参数为错误信息
 */
PageMethods.Foo = function(val1, val2, onSuccess, onFailure) {};

编辑器会识别JSDoc，显示方法签名提示。

2. 利用ScriptService自动生成代理 #

• 确保页面的@Page指令中已设置EnablePageMethods="true"
• 如果WebMethod在单独的WebService类中，给类添加[ScriptService]特性：

[ScriptService]
public class MyWebService : WebService
{
    [WebMethod]
    public static string Foo(string val1, int val2)
    {
        return "处理结果";
    }
}

• 预编译项目（用aspnet_compiler工具或VS中右键项目选择"预编译"），框架会自动生成包含方法签名的代理脚本，VS能识别这些脚本提供Intellisense。

3. 手动封装强类型调用函数 #

自己写一个包装类，把PageMethods的调用封装起来，明确参数和回调类型：

class PageMethodProxy {
    static callFoo(val1: string, val2: number, onSuccess?: (res: string) => void, onFailed?: (err: any) => void) {
        PageMethods.Foo(val1, val2, onSuccess, onFailed);
    }
    // 其他WebMethod的封装函数
}

之后调用PageMethodProxy.callFoo(...)就能获得完整的Intellisense提示，后续服务器端方法变更时，只需要更新封装类即可。

内容的提问来源于stack exchange，提问作者TheKlinto