Articles of comentarios de

¿Es una mala práctica comentar líneas únicas de CSS con //?

Recientemente comencé a usar // para “comentar” líneas únicas de código CSS. Entiendo que en realidad no estoy comentando la línea; Solo lo estoy rompiendo (debería usar /* … */ ), pero tiene el mismo efecto. La línea es terminada por el ; y el siguiente código funciona bien. Podría eliminarlo, pero a menudo prefiero […]

Comentando el código

Posible duplicado: ¿Comenta tu código? ¿Cuáles son los diferentes estándares y prácticas de la documentación del código y cuáles han funcionado mejor para usted? Lo pregunto porque mi amigo y yo estamos creando una empresa y es probable que necesitemos un estándar acordado para comentar las cosas, de modo que podamos leer el código del […]

Java: expresiones regulares que encuentran comentarios en el código

Un poco de diversión con Java esta vez. Quiero escribir un progtwig que lea un código de entrada estándar (línea por línea, por ejemplo), como: // some comment class Main { /* blah */ // /* foo foo(); // foo */ foo2(); /* // foo2 */ } encuentra todos los comentarios en él y los […]

¿Qué es el código de auto-documentación y puede reemplazar el código bien documentado?

Tengo un colega que insiste en que su código no necesita comentarios, es “auto documentación“. He revisado su código, y aunque es más claro que el código que he visto que otros producen, todavía no estoy de acuerdo en que el código de auto-documentación sea tan completo y útil como el código bien comentado y […]

Regex para comentarios en cadenas, cadenas en comentarios, etc.

Esta es una pregunta que he resuelto y quería publicar en estilo de preguntas y respuestas porque creo que más personas podrían usar la solución. O tal vez mejorar la solución, mostrar dónde se rompe. El problema Desea hacer algo con cadenas y / o comentarios entre comillas en un cuerpo de texto. Quieres extraerlos, […]

Cómo poner un comentario de línea para un comando de varias líneas

Sé cómo escribir un comando de varias líneas en un script de Bash, pero ¿cómo puedo agregar un comentario para cada línea en un comando de varias líneas? CommandName InputFiles \ # This is the comment for the 1st line –option1 arg1 \ # This is the comment for the 2nd line –option2 arg2 # […]

¿Qué estilo de comentario debería usar en los archivos por lotes?

He estado escribiendo algunos archivos por lotes, y me encontré con esta guía del usuario , que ha sido bastante informativa. Una cosa que me mostró fue que las líneas pueden comentarse no solo con REM , sino también con :: . Dice: Los comentarios en el código del lote se pueden hacer utilizando dos […]

Comentarios en Markdown

¿Cuál es la syntax para almacenar un comentario en un archivo de rebajas, por ejemplo, un comentario CVS $ Id $ en la parte superior del archivo? No encontré nada en el proyecto de rebajas .