Preguntas etiquetadas con doc

864
¿Cómo hacer referencia a un método en javadoc?

¿Cómo puedo usar la @linketiqueta para vincular a un método? Quiero cambiar: /** * 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() a: /** * Returns the Baz...

632
¿Cómo funciona "cat << EOF" en bash?

Necesitaba escribir un script para ingresar entradas de varias líneas a un programa ( psql). Después de buscar un poco en Google, encontré que la siguiente sintaxis funciona: cat << EOF | psql ---params BEGIN; `pg_dump ----something` update table .... statement ...; END; EOF Esto...

417
¿Sugerencias de tipo PHPDoc para una matriz de objetos?

Entonces, en PHPDoc se puede especificar @vararriba de la declaración de la variable miembro para insinuar su tipo. Luego un IDE, por ej. PHPEd, sabrá con qué tipo de objeto está trabajando y podrá proporcionar una idea del código para esa variable. <?php class Test { /** @var SomeObj */...

374
¿Cómo asignar un valor heredoc a una variable en Bash?

Tengo esta cadena de varias líneas (citas incluidas): abc'asdf" $(dont-execute-this) foo"bar"'' ¿Cómo lo asignaría a una variable usando un heredoc en Bash? Necesito preservar nuevas líneas. No quiero escapar de los caracteres en la cadena, eso sería molesto

316
¿Cómo describir argumentos de "objeto" en jsdoc?

// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } Pero, ¿cómo describo cómo deben estructurarse los objetos de parámetros? Por ejemplo, debería ser algo como: {...

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

Al intentar crear comentarios Javadoc a nivel de paquete, ¿cuál es el método preferido? ¿Qué haces? package-info.java Pros Más nuevo Contras Abuso de una clase: las clases son para código, no solo para comentarios package.html Pros Extensión HTML significa que no es código Resaltado...

196
¿Cuál es la ventaja de usar heredoc en PHP? [cerrado]

Tal como está actualmente, esta pregunta no es adecuada para nuestro formato de preguntas y respuestas. Esperamos que las respuestas sean respaldadas por hechos, referencias o experiencia, pero esta pregunta probablemente solicitará debate, argumentos, encuestas o discusión

192
Usando variables dentro de un bash heredoc

Estoy tratando de interpolar variables dentro de un bash heredoc: var=$1 sudo tee "/path/to/outfile" > /dev/null << "EOF" Some text that contains my $var EOF Esto no funciona como esperaba ( $varse trata literalmente, no se expande). Necesito usarlo sudo teeporque crear el archivo...