Pytania oznaczone «doc»

864
Jak odwołać się do metody w javadoc?

Jak mogę użyć @linktagu, aby połączyć się z metodą? Chcę się zmienić: /** * Returns the Baz object owned by the Bar object owned by Foo owned by this. * A convenience method, equivalent to getFoo().getBar().getBaz() * @return baz */ public Baz fooBarBaz() do: /** * Returns the Baz object...

629
Jak działa „cat << EOF” w bash?

Musiałem napisać skrypt, aby wprowadzić wieloliniowe dane wejściowe do programu ( psql). Po trochę googlingu znalazłem następującą składnię: cat << EOF | psql ---params BEGIN; `pg_dump ----something` update table .... statement ...; END; EOF To poprawnie konstruuje łańcuch wieloliniowy...

531
Przykład kodu wielu linii w komentarzu Javadoc

Mam mały przykład kodu, który chcę uwzględnić w komentarzu Javadoc dla metody. /** * -- ex: looping through List of Map objects -- * <code> * for (int i = 0; i < list.size(); i++) { * Map map = (Map)list.get(i); * System.out.println(map.get("wordID")); *

417
Podpowiedzi typu PHPDoc dla tablicy obiektów?

Tak więc w PHPDoc można wskazać @varpowyżej deklaracji zmiennej składowej, aby wskazać jej typ. Następnie IDE, np. PHPEd, będzie wiedział z jakiego typu obiektem współpracuje i będzie w stanie zapewnić wgląd w kod dla tej zmiennej. <?php class Test { /** @var SomeObj */ private...

316
Jak opisać argumenty „obiektowe” w jsdoc?

// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } Ale jak opisać strukturę obiektów parametrów? Na przykład powinno to być coś takiego: { setting1 : 123, //...

313
Jak dodać odwołanie do parametru metody w javadoc?

Czy istnieje sposób dodawania odniesień do jednego lub więcej parametrów metody z treści dokumentacji metody? Coś jak: /** * When {@paramref a} is null, we rely on b for the discombobulation. * * @param a this is one of the parameters * @param b another param */ void foo(String a, int...

230
Javadoc: package.html lub package-info.java

Kiedy próbujesz utworzyć komentarze Javadoc na poziomie pakietu, jaka jest preferowana metoda? Co robisz? package-info.java Plusy Nowszy Cons Nadużycie klasy - Klasy dotyczą kodu, a nie tylko komentarzy pakiet.html Plusy Rozszerzenie HTML oznacza, że ​​nie jest to kod Podświetlanie...

196
Jaka jest zaleta korzystania z heredoc w PHP? [Zamknięte]

W obecnej formie to pytanie nie pasuje do naszego formatu pytań i odpowiedzi. Oczekujemy, że odpowiedzi poparte będą faktami, referencjami lub wiedzą fachową, ale to pytanie prawdopodobnie będzie wymagało debaty, argumentów, ankiet lub rozszerzonej dyskusji. Jeśli uważasz, że to...

192
Używanie zmiennych wewnątrz bash heredoc

Próbuję interpolować zmienne w heredoc bash: var=$1 sudo tee "/path/to/outfile" > /dev/null << "EOF" Some text that contains my $var EOF To nie działa, jak się spodziewałem ( $varjest traktowane dosłownie, a nie rozszerzone). Muszę użyć, sudo teeponieważ utworzenie pliku wymaga sudo....