code-documentation

6El calor

4Respuesta

suprimir selectivamente los comentarios del código XML en C#?

Entregamos una serie de ensamblajes a clientes externos, pero no todas las API públicas son oficialmente compatibles. Por ejemplo, debido a opciones de diseño menos que óptimas, a veces un tipo debe e

c# xml documentation code-documentation 2010-03-19

---

35El calor

8Respuesta

¿Cuáles son las mejores prácticas para documentar el código C# con comentarios XML?

Estoy revisando un nuevo código que acabo de escribir y agregando comentarios de NDoc a mis clases y métodos. Espero generar un documento de estilo de MSDN bastante bueno para referencia. En general,

c# code-documentation ndoc 2010-06-29

---

8El calor

2Respuesta

ReSharper: cómo deshabilitar la generación de encabezados de documentación de basura en Code Cleanup

Estamos usando ReSharper 6.0 con StyleCop para ReSharper. Aunque utilizamos la regla de StyleCop de que los miembros deben tener encabezados de documentación, no queremos que el servicio de limpieza d

resharper stylecop resharper-6.0 code-documentation 2011-11-17

---

7El calor

1Respuesta

phpdoc - definición de variables de objeto de retorno para un método

He estado buscando en esto por un tiempo y o bien no estoy usando los términos de búsqueda correctos o me falta algo. Estoy tratando de averiguar si es posible usar PHPdoc para definir las variables q

php phpdoc code-documentation 2012-09-15

---

12El calor

3Respuesta

Comentario de resumen de Visual Studio XML en una sola línea

En Visual Studio, ¿cómo cambio el fragmento de comentario de resumen XML predeterminado de tres líneas a una línea? Actualmente Proporciona este fragmento cuando escribo ///: /// <summary> /// /// <

visual-studio comments xml-documentation code-documentation 2011-11-26

---

13El calor

4Respuesta

Cómo escribir comentarios de documentación en ANSI C?

No encuentro cómo escribir comentarios en C. Quiero decir, sé acerca de // y /* */, lo que quiero decir es ¿dónde puedo encontrar buenas prácticas? Al igual que si tengo una función, ¿cómo escribo el

c documentation code-documentation 2012-01-17

---

10El calor

3Respuesta

Cómo documentar la devolución en JavaScript

Estoy escribiendo mi propia biblioteca para el proyecto en el trabajo para una aplicación de navegador y estoy teniendo el mismo viejo problema para decidir cómo comentar el código. Intento seguir la

javascript google-closure-compiler jsdoc code-documentation 2012-06-20

---

5El calor

3Respuesta

¿Hay alguna herramienta de documento API de JavaScript fuera de línea disponible como YARD para ruby?

La documentación en línea de Mozilla es excelente, pero a veces no tengo conexión a Internet y la referencia en la guía definitiva de o'reilly javascript también es excelente, pero no tiene la capacid

javascript code-documentation 2012-01-24

---

10El calor

1Respuesta

¿Cómo puedo obligar a Doxygen a mostrar la ruta completa de inclusión?

¿Cómo puedo obligar a Doxygen a mostrar la ruta completa de inclusión? ¿Qué quiero decir: tengo una clase foo::bar::bee definido en bee.hpp en siguiente estructura de directorios: foo foo/bar foo/ba

c++ include doxygen code-documentation 2010-03-11

---

148El calor

4Respuesta

codestyle; poner javadoc antes o después de la anotación?

Sé que no es el más importante de los problemas, pero me acabo de dar cuenta de que puedo poner el bloque de comentarios javadoc antes o después de la anotación. ¿Qué querríamos adoptar como estándar

java coding-style annotations javadoc code-documentation 2010-06-24

---