W Visual Studio 2008 mamy możliwość korzystania z intellisense dla różnych bibliotek javascript. Aby jednak korzystać z tego dobrodziejstwa musimy:
- zainstalować SP1 do Visual Studio 2008 (wcześniej SP1 do .NET Framework 3.5)
- zainstlować patha KB958502
Po instalacji tych elementów możemy korzystać z instellisense dla różnych bibliotek javascript. Oczywiście biblioteki te musimy zadeklarować na naszej stronie.
[sourcecode language=”xhtml”]
<script src="js/mylibrary.js" type="text/javascript"></script>
[/sourcecode]
Poza standardowym “podpowiadaniem” funkcji/metod/itp. dla bibliotek js, path ten umożliwia korzystanie również z dokumentacji. Dokumentację tworzymy pisząc komentarze podobne do komentarzy z C#, np.:
[sourcecode language=”xhtml”]
function TestFunction(imie) {
/// Przykładowa funkcja javascript
/// Pierwszy parametr funkcji
/// Wartość zwracana
return "test";
}
[/sourcecode]
Funkcjonalność patha jest bardzo przemyślana i umożliwia korzystanie z komentarzy umieszczonych w innym pliku niż nasza biblioteka. Jak wiadomo, pliki javascript powinny być jak najmniejsze, a tworzenie w nich dokumentacji na pewno w tym nie pomaga 🙂
Kolejność przeszukiwania plików w poszukiwaniu dokumentacji wygląda tak:
- mylibrary-vsdocs.js
- mylibrary-debug.js
- mylibrary.js
Jeżeli nie zostanie znaleziony plik mylibrary-vsdocs.js szukany jest mylibrary-debug.js, itd. Oczywiście deklarujemy tylko mylibrary.js – plik z dokumentacją powinien jednak znajdować się w tym samym katalogu (jednak nie musi być nawet includowany w projekcie).
Jeżeli deklaracja pliku js znajduje się innym pliku (np. w MasterPage), wtedy w naszym pliku musimy podać referencję:
[sourcecode language=”xhtml”]
/// <reference path="js/mylibrary.js" />
[/sourcecode]
lub
[sourcecode language=”xhtml”]
/// <reference path="Default.aspx" />
[/sourcecode]
Wszystkich, którzy piszą w jQuery z pewnością ucieszy fakt, iż od jakiegoś czasu przygotowywane są pliki z dokumentacją do tej biblioteki.
Dokumentację znaleźć można na stronie jQuery.
1 comment
Comments are closed.