Saltar a contenido

CodeNotes

Autor

Uso:

  • python codenotes.py documento_de_entrada

CodeNotes es un programa que te permite tomar notas y comentarios a partir del código fuente de tus proyectos de programación. Con CodeNotes, puedes resaltar y etiquetar secciones de código, agregar notas y comentarios útiles, y mantener un registro organizado de tus pensamientos y observaciones sobre tu trabajo. De esta manera, podrás mantener un registro claro y detallado de tu proceso de programación y asegurarte de que no pierdas ninguna idea o detalle importante.

Procesa una línea y escribe el comentario en el archivo de salida.

  • def procesar_linea(linea, archivo_salida):

  • cim es caracter de inicio de comentario y cfm es caracter de final de comentario.

Verifica las lineas de comentario:

if linea.startswith(comentarios[cim] and not (linea.startswith(" ") or linea.startswith("\t"))):

  • Verifica si la línea actual es el inicio de un comentario de varias líneas y no comience con espacios en blanco o tabulaciones y Verifica si la línea actual comienza con el carácter de inicio de un comentario de varias líneas específico cim.

  • La función readline() se utiliza para leer una línea completa del archivo y devolverla como una cadena de caracteres.

  • La función rstrip() se utiliza para eliminar los caracteres de espacio en blanco al final de la línea leída. Esto es útil para eliminar los saltos de línea (\n) que se agregan automáticamente al final de cada línea en un archivo de texto.

  • La función strip() se utiliza para eliminar los caracteres de espacio en blanco al principio y al final de la línea.

  • La función endswith() se utiliza para verificar si una cadena de caracteres termina con otra cadena de caracteres específica.

def convierte(documento): Extrae los comentarios de un documento de código y los guarda en un documento con extensión .md.

Diccionarios Contenidos:

  • Contiene Diccionario: comentarios que relaciona las extensiones con los caracteres de comentario de una línea

  • Contiene Diccionario: comentarios_multilinea que relaciona las extensiones con los caracteres de comentario de varias líneas.

  • La importación de los diccionarios debe ser local a la función o el programa no funcionará. por el comentario en el diccionario.

  • Consulte los diccionarios se encuentran en dicc.py allí puede agregar o modificar extensiones, sus cim y cfm