En bastante base de código puede ver comentarios que indican cosas como:
// Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade)
Así que tengo algunas preguntas, pero todas están relacionadas.
¿Está bien poner un enlace a las preguntas SO en los comentarios de un programa:
// We're now mapping from the "sorted-on column" to original indices.
//
// There's apparently no easy way to do this in Java, so we're
// re-inventing a wheel.
//
// (see why here, in SO question: http://stackoverflow.com/questions/951848)
¿Tú lo haces?
¿Y cuáles son los inconvenientes al hacerlo? (ver mi primer comentario para un terrible inconveniente)
Respuestas:
Lo he hecho, tal vez no específicamente para Stack Overflow, sino para blogs técnicos, foros, Usenet, Grupos de Google o cualquier otro lugar donde el "por qué hice esto" puede no estar completamente claro en el contexto.
No veo por qué usar SO de esta manera sería algo malo, a menos que archiven y eliminen viejas preguntas (lo cual no creo que hagan, pero no estoy seguro), pero incluso si lo hacen, no es peor que cualquier otro sitio.
Si está realmente preocupado por eso, siempre puede tomar capturas de pantalla o descargar estas páginas como texto (o pasar por la molestia de obtener imágenes, hojas de estilo, etc.) y guardarlas en un repositorio de conocimiento de su empresa, adjuntando un identificador único, y poner ese identificador único en sus comentarios para permitirle hacer referencia más tarde, entonces tendría un lugar consistente para este tipo de cosas. Pero eso puede ser excesivo, dependiendo de la complejidad e importancia de su código.
fuente
En general, la mejor manera de crear este enlace es a través del sistema de versiones y / o el sistema de seguimiento de errores. Sin embargo, el requisito para que esto funcione es que puede vincular con precisión su código al rastreador de errores o al lugar en el sistema de versiones donde coloca sus comentarios.
fuente
Idealmente, su código no necesita tales comentarios porque está bien estructurado, etc. Pero sí, cuando su situación es menos que ideal, es aceptable incluir comentarios como este. Y los enlaces a stackoverflow.com son tan buenos (¡y a menudo mejores!) Que otros.
Esperemos que sean comentarios temporales, y se le permitirá volver y mejorar el código y sacar estos comentarios .
Todavía no he puesto un enlace StackOverflow.com en mi código. Intento evitar poner enlaces en el código, ya que huele mal, pero cuando llegue el momento no dudaré.
Editar : creo que mi respuesta anterior da la impresión de que la necesidad de comentarios como este es evitable. Por supuesto, a veces es no evitable; es un error en una biblioteca o un diseño de API deficiente sobre el que no tiene control. Comentarios como este, incluidos enlaces, son muy útiles para el próximo desarrollador.
fuente
Lo veo como escribir un trabajo de investigación. Si uso las ideas de otra persona, entonces debo dar crédito a esas ideas. He usado una respuesta de stackoverflow en mi código antes, y agregué el enlace a los comentarios del método.
Como alguien mencionó, SO es un estilo wiki, por lo que es posible que pueda cambiar, pero en general la idea debería ser la misma.
Todavía debe dar crédito a los demás cuando use sus ideas.
fuente
Si ha necesitado implementar una solución alternativa, y no es obvio por qué la implementación se realizó de una manera particular, entonces debería dejarse un comentario para identificar las razones. Creo que colocar un enlace a una referencia en línea está bien, pero realmente debe haber hecho su comentario conciso, pero lo suficientemente completo como para que el enlace solo proporcione una explicación ampliada si el lector siente la necesidad de verificar su razonamiento.
Si, por otro lado, el código se ha copiado literalmente, entonces un enlace a la fuente original es justo y puede ser necesario dependiendo de la redacción de la licencia bajo la cual se le ha permitido copiar el trabajo del autor original.
fuente