Preguntas etiquetadas con documentation

Recientemente comencé a estudiar Python , pero no pude encontrar cómo implementar comentarios de varias líneas. La mayoría de los idiomas tienen símbolos de comentario de bloque como /* */ Intenté esto en Python, pero arroja un error, por lo que probablemente esta no sea la forma correcta. ¿Python realmente …

1157 python  comments  documentation 

En el Objetivo C, puedo usar #pragma markpara marcar secciones de mi código en el navegador de símbolos. Como se trata de un comando de preprocesador en C, no está disponible en Swift. ¿Hay un sustituto para esto en Swift, o tengo que usar comentarios feos?

935 swift  documentation 

Cerrada . Esta pregunta está basada en la opinión . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que pueda ser respondida con hechos y citas editando esta publicación . Cerrado hace 2 años . He visto algunos estilos diferentes de escribir cadenas de documentos …

888 python  coding-style  documentation  docstring 

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 extendida. Si cree que esta pregunta se puede mejorar y posiblemente volver a …

258 documentation  comments 

Cerrado. Esta pregunta no cumple con las pautas de desbordamiento de pila . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que sea sobre el tema de Stack Overflow. Cerrado hace 2 años . Mejora esta pregunta Una de las nuevas características de Xcode 5 …

186 objective-c  documentation  comments  doxygen  xcode5 

Así que entiendo completamente cómo usar el remuestreo , pero la documentación no hace un buen trabajo explicando las opciones. Entonces, la mayoría de las opciones en la resamplefunción son bastante sencillas, excepto por estas dos: regla: la cadena de desplazamiento u objeto que representa la conversión de destino cómo: …

184 python  documentation  pandas 

Cerrada . Esta pregunta está basada en la opinión . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que pueda ser respondida con hechos y citas editando esta publicación . Cerrado hace 2 años . Mejora esta pregunta Ok, entonces leí tanto PEP 8 como …

167 python  documentation  module 

Cerrada . Esta pregunta está basada en la opinión . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que pueda ser respondida con hechos y citas editando esta publicación . Cerrado hace 2 años . Mejora esta pregunta Actualmente estoy comenzando con Python y tengo …

162 python  documentation  javadoc  docstring 

Actualmente estoy escribiendo un pequeño marco que será utilizado internamente por otros desarrolladores dentro de la empresa. Quiero proporcionar buena información de Intellisense, pero no estoy seguro de cómo documentar las excepciones lanzadas. En el siguiente ejemplo: public void MyMethod1() { MyMethod2(); // also may throw InvalidOperationException } public void …

139 c#  .net  documentation  intellisense 

¿Cómo documentar métodos con parámetros utilizando las cadenas de documentación de Python? EDITAR: PEP 257 da este ejemplo: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0) """ if imag == 0.0 and real == 0.0: …

139 python  documentation  documentation-generation 

Cerrado. Esta pregunta no cumple con las pautas de Stack Overflow . Actualmente no acepta respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que esté relacionada con el tema de Stack Overflow. Cerrado hace 12 meses . Mejora esta pregunta Estoy tratando de encontrar documentación para usar la API …

119 c  api  documentation  ffmpeg 

Cerrado . Esta pregunta se basa en opiniones . Actualmente no acepta respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que pueda responderse con hechos y citas editando esta publicación . Cerrado hace 6 años . Mejora esta pregunta TeX / LaTeX es genial, lo uso de muchas maneras. …

118 documentation  latex  tex 

Cerrado . Esta pregunta se basa en opiniones . Actualmente no acepta respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que pueda responderse con hechos y citas editando esta publicación . Cerrado hace 2 años . Mejora esta pregunta Estoy escribiendo una clase ligera cuyos atributos están destinados a …

115 python  class  documentation  docstring  class-attributes 

En JSDoc, la mejor documentación que puedo encontrar muestra cómo usar lo siguiente si tiene una matriz de un tipo específico (como una matriz de cadenas) como: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } ¿Cómo reemplazaría los siguientes signos de interrogación para …

105 javascript  documentation  jsdoc 

¿Existe un estándar para interpretar la sintaxis de las interfaces de función en la documentación de API y, en caso afirmativo, cómo se define? Aquí hay un ejemplo sobre cómo cambiar el color de un elemento en la guía de secuencias de comandos de JavaScript para Photoshop para la función …

103 api  documentation