ESTA ETIQUETA ES SOLO PARA GENERADORES DE DOCUMENTOS. Incluya también el idioma y / o la etiqueta SDE. NO UTILICE para solicitar enlaces a documentación o herramientas, o para criticar la documentación del proveedor.
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....
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
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...
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
Al escribir documentación xml puede usar <see cref="something">something</see>, lo que funciona, por supuesto. Pero, ¿cómo hace referencia a una clase o un método con tipos genéricos? public class FancyClass<T> { public string FancyMethod<K>(T value) { return "something...
Esto debería ser muuuucho más fácil ... Quiero agregar un salto de línea "codificado" a la documentación XML en mi código /// <summary> /// Get a human-readable variant of the SQL WHERE statement of the search element. <br/> /// Rather than return SQL, this method returns a...
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...
Sé que no es el más importante de los problemas, pero me di cuenta de que puedo poner el bloque de comentarios javadoc antes o después de la anotación. ¿Qué nos gustaría adoptar como estándar de codificación? /** * This is a javadoc comment before the annotation */ @Component public class...
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...
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 .
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 .
¿Cómo puedo decirle a JSDoc sobre la estructura de un objeto que se devuelve? Encontré la @return {{field1: type, field2: type, ...}} descriptionsintaxis y la probé: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or...
¿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...
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...
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...
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...
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...
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...
¿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...
La documentación para habilitar la integración de XmlDoc en sus proyectos Web Api parece solo manejar situaciones en las que todos sus tipos de API son parte de su proyecto WebApi. En particular, analiza cómo redirigir la documentación XML App_Data/XmlDocument.xmly descomentar una línea en su...