Pomoc - Szukaj - Użytkownicy - Kalendarz
Pełna wersja: Edytor ze wsparciem dla PHPDoc
Forum PHP.pl > Forum > PHP
Nalfein][WR
Znacie może jakiś porządny edytor php, który miałby wbudowane mechanizmy generujące odpowiednie komentarze zgodne z PHPDoc/JavaDoc przy dodawaniu kolejnych metod do klas? Trochę niewygodnie ręcznie robi się te wszystkie ramki, a żaden edytor jaki znam nie posiada takowego wsparcia. Możecie polecić coś wartego uwagi?
rzseattle
http://forum.php.pl/viewtopic.php?t=3780&h...&highlight=news

patrz koniec postu, nie wie czy ten edytor to jest do php no ale to juz scannera trza spytac bo ten program sie nie pojawil w download
Nalfein][WR
niestety nie bardzo:

PHPDoc != DocBook

PHPDoc/JavaDoc - tworzenie samodokumentującego się kodu poprzed dodawanie odpowiednich komentarzy w kodzie php, które później analizuje parser i tworzy dokumentację.

DocBook - XML-owy język znaczników służący do zapisu dokumentacji i artykułów tj. akapity, działy, poddziały etc.

Taki edytor przydałby się całemu zespołowi pracującemu nad Thotem, gdyż trzeba będzie ustalić jakiś standard komentowania klas i funkcji. Lepszego z JavaDoc nie znam, ale też nie znam żadnego edytora, który by wspierał go w php. W tym tkwi problem smile.gif
rzseattle
Sorki czytalem naszybko i mala pomykami wyszla
DeyV
częściowe (bardzo prymitywne) wsparcie zapewnia zend studio, gdzie, w momencie, gdy (po uprzednim jej zadeklarowaniu) chcemy wykorzystać jakąś funkcję, i zaczynamy wpisywać jej nazwę, pojawia się dymek, z dokończeniem nazwy teżjże funkcji. Jeśli jest tylko jedna takowa, pojawia się również link add description, automatycznie tworząc kod w postaci
[php:1:cb390bca61]<?php
/**
* @return unknown
* @desc Enter description here...
*/?>[/php:1:cb390bca61]
Ale to wciaz mało, i strasznie na około...
FiDO
Od biedy mozna sobie potworzyc makra wpisujace odpowiednie ciagi znakow (osobne dla funkcji, klas, zmiennych itp.), oczywiscie to raczej malo wygdone wyjscie, ale ja np. i tak nie lubie korzystac z kombajnow typu Komodo, PHPEd czy inne. "Moj" edytor musi sie odpalac w mniej niz sekunde smile.gif
Co do makr to niektore edytory umozliwiaja pisanie bardziej skomplikowanych makr, wtedy moznaby zrobic jedno uniwersalne, ktore wykryje czy to deklaracja funkcji/zmiennej czy czego tam.
Np. mam taki dodatek do Visual C++, ktory po wcisnieciu jednej kombinacji klawiszy robi dokladnie cos takiego jak chcecie... tylko ze to do DoxyGen (taki PHPDoc dla C++).


PS. DeyV ktorego PHPDoc masz na mysli, bo jest ich kilka?
Nalfein][WR
Tego co się wywodzi z JavaDoc zapewne.

Zainstalowałem Zend Studio i teraz żałuję, że ściągałem te ponad 20 MB. Kolejne IDE w Javie o topornym interfejsie. Myślałem, że panowie z Zenda bardziej się postarają...
FiDO
Cytat
[WR"]Tego co się wywodzi z JavaDoc zapewne.

Na 3 ktore sprawdzilem przy kazdym pisalo, ze sie opiera na JavaDoc, wiec to nadal mi malo mowi winksmiley.jpg
Cytat
Zainstalowałem Zend Studio i teraz żałuję, że ściągałem te ponad 20 MB. Kolejne IDE w Javie o topornym interfejsie. Myślałem, że panowie z Zenda bardziej się postarają...

Dokladnie takie same odczucia mam...
DeyV
za standard dla THOT'a przyjeliśmy http://www.phpdoc.org/ i dla niego warto by szukać wsparcia.
Jabol
http://maguma.com ma wsparcie dla jakis komentarzy podobnych w strukturze, ale nie wiem czy to jest phpdoc
Cytat
Through tight integration of the php interpreter and the php documentation, Maguma Studio gives developers a time-saving development tool. Features full integration of the php interpreter and the php documentation
Nie napisali jaki to php documentation system, ale jest bardzo podobny.
Nalfein][WR
Cytat
Na 3 ktore sprawdzilem przy kazdym pisalo, ze sie opiera na JavaDoc, wiec to nadal mi malo mowi


Na oko zgadza się z tym, który przyjęliśmy, czyli phpDocumentor. Choć szkoda, że składnia nie jest w pełni kompatybilna z JavaDoc (@return zamiast @returns itp.), tamten fajne strony produkuje i jest już nieźle dopieszczony. Ale cóź.

BTW: A co myślicie o sposobie komentowania popularyzowanym z .Net tj. umieszczaniem znaczników XML w komentarzach?!?

Co do samego edytora najlepszy jaki znalazłem: PHPEdit. Będąc w ciele metody klikasz na przycisk dodawania dokumentacji w okienku edycyjnym i masz wygenerowany komentarz zgodny z phpDocumentor z nazwą metody, miejscem na opis, wypisanymi parametrami i zwracanym wynikiem. Wystarczy wpisać zawartość. Programik ogólnie bardzo fajny, wygodny interfejs, dość lekki (1.8 MB) - mi już przypadł do gustu smile.gif
To jest wersja lo-fi głównej zawartości. Aby zobaczyć pełną wersję z większą zawartością, obrazkami i formatowaniem proszę kliknij tutaj.
Invision Power Board © 2001-2025 Invision Power Services, Inc.