在使用Visual Studio做開發(fā)的時(shí)候，智能感知是非常方便的。從VS2008開始，提供了對(duì)javascript的智能感知支持。例如

上述代碼中，我們先用document對(duì)象的getElementById的方式取得了文檔中的一個(gè)Id為form1的元素，實(shí)際上就是默認(rèn)的那個(gè)窗體元素。然后，我們將其賦給一個(gè)名為f的變量。

然后，我們?cè)谑褂胒 這個(gè)變量的時(shí)候，就能自動(dòng)地列出該form元素所應(yīng)該有的一些成員，例如action等等。

這些屬于是默認(rèn)的元素和方法的智能感知，假設(shè)我們自己有一些自定義js代碼，如何讓它也能夠智能感知呢？

答案是：對(duì)于自定義方法的智能感知，是自動(dòng)的。

例如，我們?cè)陧?yè)面中添加一個(gè)方法如下

function Helloworld(name) {
??? alert("hello," + name);
}

然后在文檔的任何一個(gè)部分，我們想調(diào)用該方法，都可以自動(dòng)地被智能感知識(shí)別到

這種智能感知應(yīng)該是最基本的。但是我們經(jīng)常在用c#編寫代碼的時(shí)候，有另外一種更好的智能感知：就是說不光是列出方法名，而且會(huì)有對(duì)該方法以及它的參數(shù)，返回值的詳細(xì)描述，這樣使用者就可以更好地使用該方法了。如下所示

這是怎么實(shí)現(xiàn)的呢?其實(shí)這是通過注釋來實(shí)現(xiàn)的，如下面所示

/// <summary>
/// 根據(jù)一個(gè)人名返回一個(gè)問候語(yǔ)
/// </summary>
/// <param name="name">要問候的人</param>
/// <returns>返回的問候語(yǔ)</returns>
public string Helloworld(string name)
{
??? return "hello," + name;
}

這種注釋我們稱為XML注釋，是從.NET 2.0開始提供的一種新功能。

?

好，了解了上面的知識(shí)后，如果我們需要為我們的javascript代碼添加類似的智能感知提示，那么能不能也用注釋呢？

是的，我們的確可以這么做

function SomeMethod(a, b) {
??? /// <summary>
??? /// 這是一個(gè)方法
??? /// </summary>
??? /// <param name="a">這是參數(shù)a</param>
??? /// <param name="b">這是參數(shù)b</param>
??? /// <returns>方法的返回值</returns>
??? return "Hello,worod";
}

有一點(diǎn)不同的是，這些注釋是寫在方法內(nèi)部的，而不像C#那樣寫在方法外部。而且，如果要實(shí)現(xiàn)這樣的功能，以上函數(shù)就不能直接在aspx頁(yè)面中編寫，而是要單獨(dú)寫一個(gè)js文件。如default.js

然后在aspx中添加對(duì)該js的引用

<script src="default.js" type="text/javascript"></script>

本文由作者：陳希章 于 2009/7/12 19:17:26 發(fā)布在：http://www.cnblogs.com/chenxizhang/
本文版權(quán)歸作者所有，可以轉(zhuǎn)載，但未經(jīng)作者同意必須保留此段聲明，且在文章頁(yè)面明顯位置給出原文連接，否則保留追究法律責(zé)任的權(quán)利。
更多博客文章，以及作者對(duì)于博客引用方面的完整聲明以及合作方面的政策，請(qǐng)參考以下站點(diǎn)：陳希章的博客中心

總結(jié)

以上是生活随笔為你收集整理的如何为javascript代码编写注释以支持智能感知的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。