VBdocman to program do automatycznego generowania dokumentacji technicznej z plików źródłowych Visual Basic za pomocą zaledwie kilku kliknięć myszą. Analizuje kod źródłowy i automatycznie tworzy spis treści, indeks, tematy, odsyłacze i pomoc kontekstową. Format dokumentacji wyjściowej jest w pełni konfigurowalny przez użytkownika. Wstępnie zdefiniowane formaty wyjściowe to:
Pomoc HTML (plik*.chm, który wygląda jak MSDN)-
Pliki HTML (z indeksem Java i spisem treści)
WinHelp (plik*.hlp)
Dokument RTF
Xml
VBdocman działa jako dodatek do MS Visual Basic 6.0. Po wywołaniu prostego okna dialogowego za pomocą menu głównego i (w najprostszym przypadku) kliknięcie jednego przycisku jest generowana określona dokumentacja wyjściowa. Automatycznie tworzy wszystkie interesujące łącza, takie jak Dotyczy, Metody, Zdarzenia, Właściwości, Zdarzenia, Spis treści i indeks. W większych projektach tylko ta praca oszczędza wiele dni nudnej pracy. Dokumentacja może być następnie edytowana i podany tam dodatkowy opis, taki jak Zobacz też, Przykłady łączy, obiekt, metoda, opis właściwości lub zdarzenia, opis parametrów i tak dalej. VBdocman pozwala dodać nawet ten opis automatycznie, wyodrębniając go z komentarza kodu źródłowego ze specjalnych tagów. Działa podobnie jak system JavaDoc. Ale użytkownik nie jest zmuszony do pisania komentarzy ręcznie, VBdocman dodaje go tylko za pomocą dwóch kliknięć myszą. Wszystkie niezbędne tagi są dodawane, a użytkownik wypełnia tylko krótki opis do nich. Ponadto zapewnia wyrafinowany edytor komentarzy przyjazny dla użytkownika.
Zalety:
Spójności. Jeśli coś zostało dodane do kodu np.
Dokumentacja w różnych formatach może być generowana za pomocą kilku kliknięć myszą. Więc masz dokumentację we wszystkich obsługiwanych formatach w ciągu kilku minut.
Efektywna komunikacja w zespole, zwłaszcza gdy używany jest System Source Safe. Każdy programista komentuje swoją część kodu.
historia wersji
- Wersja 2.25 opublikowany na 2005-11-09
Ulepszone dane wyjściowe i poprawki błędów.
Szczegóły programu
Eula
Umowa licencyjna użytkownika końcowego – Umowa licencyjna użytkownika końcowego
UMOWA LICENCYJNA VBDOCMAN
Dodatek VBdocman nie jest darmowy. Oznacza to:
Wszystkie prawa autorskie do VBdocman są wyłącznie własnością autora - Peter Macej (HELIXOFT).
Każdy może korzystać z tego oprogramowania w okresie próbnym 14 dni.
Po upływie tego okresu próbnego wynoszącego 14 dni lub krótszym, jeśli
aby korzystać z VBdocman, musisz się zarejestrować (kupić). Kupując VBdocman, stajesz się
zarejestrowanego użytkownika.
Istnieją następujące typy licencji wydanych dla VBdocman:
1. Licencja na użycie pojedynczego komputera. Użytkownik kupuje licencję ONE
, aby użyć VBdocman na jednym komputerze.
2. LICENCJA SITE USAGE. Użytkownik kupuje jedną licencję USAGE,
zezwalając na korzystanie z VBdocman przez nabywcę, nabywców
pracowników lub akredytowanych agentów, na nieograniczonej liczbie komputerów
w tej samej fizycznej lokalizacji site. Ta lokalizacja witryny
zwykle definiowany jest jako pojedynczy budynek, ale można go uznać za
jest liczbą budynków w obrębie tych samych, ogólnych, geograficznych
lokalizacji, takiej jak osiedle przemysłowe lub małe miasteczko.
Po zarejestrowaniu użytkownik otrzymuje niewyłączną licencję na
VBdocman na tylu komputerach, ile jest zdefiniowanych w powyższych postanowieniach licencyjnych
w zależności od liczby zakupionych licencji, w jakimkolwiek celu prawnym.
Nie wolno używać, kopiować, emulować, klonować, wynajmować, dzierżawić, sprzedawać, modyfikować,
dekompilować, dezasemble, w inny sposób odtwarzać inżyniera dźwięku lub
licencjonowanego programu lub dowolnego podzbioru licencjonowanego programu, z wyjątkiem
przewidzianych w niniejszej umowie. Każde takie nieautoryzowane użycie
natychmiastowego i automatycznego wygaśnięcia niniejszej licencji i może
ścigania karnego i/lub cywilnego.
Wersja próbna VBdocman może być swobodnie rozpowszechniana,
pod warunkiem, że pakiet dystrybucyjny nie zostanie zmodyfikowany. Żadna osoba ani
firma może pobierać opłatę za dystrybucję VBdocman bez pisemnego
zgody autora.
Aby się zarejestrować, zobacz witrynę domową VBdocman http://www.vbdocman.com
OGRANICZONA GWARANCJA
Autor nie gwarantuje, że funkcje zawarte w tym oprogramowaniu
spełni Twoje wymagania lub że oprogramowanie będzie wolne od błędów.
W ŻADNYM WYPADKU AUTOR NIE PONOSI ODPOWIEDZIALNOŚCI ZA JAKIEKOLWIEK SZKODY, W TYM
UTRACONE ZYSKI, UTRACONE OSZCZĘDNOŚCI LUB INNE SZKODY PRZYPADKOWE LUB WTÓRNE
WYNIKAJĄCYCH Z KORZYSTANIA LUB NIEMOŻNOŚCI KORZYSTANIA Z TEGO PROGRAMU LUB
PRZEZ JAKĄKOLWIEK INNĄ STRONĘ. CAŁEGO RYZYKA ZWIĄZANEGO Z WYNIKAMI I WYNIKAMI
PROGRAM I DOKUMENTACJA SĄ PRZYJMOWANE PRZEZ CIEBIE.
Autor zachowuje tytuł własności oprogramowania. Wszystkie kopie i
części oprogramowania, w jakiejkolwiek formie, należą do autora, który zachowuje
wszystkich praw, które nie zostały wyraźnie przyznane.
Instalacja i używanie VBdocman oznacza akceptację niniejszych warunków i
warunków licencji.
Jeśli nie zgadzasz się z warunkami niniejszej licencji, musisz usunąć VBdocman
plików z urządzeń pamięci masowej i zaprzestać korzystania z produktu.
