Comenzando una oración con un nombre de función? [cerrado]

Ocasionalmente, mientras escribo algo relacionado con un lenguaje de programación que distingue entre mayúsculas y minúsculas, termino comenzando una oración con el nombre de una función. Ahora, las reglas del inglés establecen que la primera palabra de una oración debe escribirse en mayúscula; sin embargo, el nombre de la función es minúscula. Si se pregunta qué podría estar diciendo que resultaría en que la primera palabra sea un nombre de función, tome este ejemplo:

Su implementación de fread está rota. fread necesita devolver cuántos bytes se leyeron.

Entiendo que podría cambiar la segunda instancia de fread a It, pero quiero saber la mejor manera de manejar esto que no sea simplemente reescribir la oración. ¿Debo poner en mayúscula el nombre de la función? La única forma en que me gustaría escuchar "reescribir la oración" como respuesta es si comenzar la oración con un nombre de función viola alguna regla en inglés de la que no estoy al tanto. Editar: Realmente agradezco a todos por estas respuestas. Han cambiado y mejorado mi visión del problema. He aprendido bastante de esto. Estoy muy sorprendido de no haber pensado en estas soluciones simples pero buenas.

Creo que mi postura sobre la alternancia de la oración fue demasiado difícil y ahora, debido a estas buenas respuestas, me doy cuenta de que alterar la oración en general parece ser la mejor opción para tratar estos casos, ya sea agregando paréntesis después de la función o diciendo La función antes de la oración. nombre de la función y, si está disponible, utilizando el formato para el nombre de la función.

En la tipografía, esto generalmente se maneja usando una representación diferente, ya sea que sea o no el comienzo de una oración, para indicar que lo que golpea el ojo no es solo una palabra en la oración sino una entidad especial.

Su freadimplementación está rota. freadnecesita devolver cuántos bytes se leyeron.

Dependiendo de cuán formal sea un documento, puede adoptar el mismo enfoque. En cualquier caso, esto elimina el problema que identifica, por lo que es posible que desee utilizarlo solo por ese motivo.

En el mundo del texto plano (como lo señalan varios en comentarios y otras respuestas), agregar paréntesis a los nombres de funciones ayuda un poco, pero como también necesitamos referirnos a entidades que no toman paréntesis, esto tiene un valor limitado. En general, a menos que se adopte una convención de rodear el texto con caracteres especiales como corchetes y asteriscos, en el mundo del texto plano no hay más opción que eludir el problema reestructurando la oración.

Si existe un requisito absoluto para comenzar cada oración con un límite, simplemente reemplácela freadcon "La freadfunción" donde sea que comience una oración.

Si no tiene medios tipográficos para distinguir (según otra respuesta), y tal vez incluso si los tiene, puede ser útil indicar que está hablando de una función usando parens:

Su implementación fread () está rota. fread () necesita devolver cuántos bytes se leyeron.

Esto ayuda a "explicar" por qué no se escribe con mayúscula al comienzo de la segunda frase, y también ayuda (en la primera frase) para entender por qué el nombre propio (nombre de una función) no se escribe con mayúscula no sea . Dado que (como un nombre propio) podría decirse que debería haber sido.

("posiblemente" porque podríamos discutir si fread () es un nombre genérico o un nombre propio).

En general, el uso de parens ayuda al cerebro del lector a comprender por qué aparecen palabras extrañas y cuáles son.

Puede comenzar la oración desde la descripción:

La función fread[…]

El método fread[...]

La propiedad breadColor[…]

Puede comparar esto con las matemáticas en línea en las publicaciones. Muy rara vez verá oraciones que comienzan con una variable u otra matemática en línea.

Por lo tanto, concluyo que debes evitar los nombres de las funciones al comienzo de una oración.

Quizás esta pregunta proporcione más detalles: ¿Está bien comenzar una oración con una letra griega (variable)? .

La página de manual de Linux para fread (3) que otros vincularon es un gran ejemplo de cuatro soluciones comunes.

1. Comience su oración con "La función foo" o "La función foo". "La función fread necesita regresar ..." .
2. Marque el nombre de la función con caracteres adicionales de acuerdo con la convención utilizada por su comunidad de lenguaje de programación. En el caso de C, un par de paréntesis vacío, por lo que "fread () necesita regresar ..." .
3. Utilice la tipografía (negrita, caracteres de ancho fijo o cursiva) para resaltar el nombre de la función, como: " fread necesita regresar ..."
4. En los sistemas que usan man, si su función tiene una página de manual, consulte el capítulo del manual entre paréntesis. Entonces "fread (3) necesita regresar ..."

Los piratas informáticos reconocerán los cuatro enfoques al instante, y usted debería poder elegir uno que coincida con el estilo de su casa o su voz personal.

Como dijiste, no puedes confiar en la tipografía para resaltar el nombre de tu función. La sintaxis de Markdown está pensada para hacer que la documentación sea legible incluso cuando un intérprete de markdown no está disponible, por lo tanto, rodee el nombre de su función con un par de teclas de retroceso. (Esta es, supongo, una combinación de las opciones 2 y 3.)

La opción 2 varía según el lenguaje de programación. Por ejemplo, Ruby y Smalltalk documentos a menudo preceden a los nombres de métodos de instancias con un hash, como #fread . Mientras tanto, Lispers puede preferir que el nombre de la función sea simple, pero lo entenderá si escribe una llamada de función esqueleto, como (fread ...) o (fread) . Enjuague y repita para todos los idiomas que documente.

Solo voy a responder por el ejemplo específico dado:

Su implementación de fread está rota. fread necesita devolver cuántos bytes se leyeron.

Simplemente reemplace el primer punto final (punto) con un punto y coma:

Su implementación de fread está rota; fread necesita devolver cuántos bytes se leyeron.

Sé que esto ya ha sido respondido, y la respuesta aceptada es bastante buena, pero solo quiero aclarar algo.

En la gramática inglesa adecuada, la conclusión es la siguiente: a veces los nombres propios reciben nombres que no comienzan con una letra mayúscula, y en la mayoría de los casos, están tan unidos a no estar en mayúscula como a los nombres propios "normales". siendo capitalizado. En tales casos, que sin duda incluiría la mayoría de los nombres de funciones en lenguajes descendientes en C , no se escribe con mayúscula el nombre, ni siquiera al comienzo de una oración. De hecho, es una mala gramática y ortografía inglesa hacerlo. Esto es en realidad parte del mismo principio de por qué es correcto deletrear la consola de juegos de Sony "PlayStation", pero no "Playstation".

Hay otros casos en los que no se supone que un nombre propio esté en mayúscula por defecto, y sin embargo puede ser (y debería ser) cuando se usa al comienzo de una oración. El nombre del idioma brainfuck es un ejemplo de esto. Las funciones en lenguajes descendientes en C no lo son. myFunc()y MyFunc()son dos cosas totalmente diferentes en idiomas como ese, y comenzar una oración con la palabra "MyFunc ()" solo se referirá a lo último, no a lo primero. Sin embargo, en VB.NET, esta es un área gris, ya que estas dos funciones serían lo mismo en ese idioma, aunque los nombres de las funciones también retendrían los esquemas de capitalización especificados por el usuario, en algún nivel u otro.

Además, a pesar de que las reglas inglesas se establecen en piedra en este caso, por lo general tienden a ser un poco confusas en torno a cosas como esta. El inglés no fue diseñado pensando en cosas como esta, por lo que para otras cosas como esta, hay espacio para la improvisación.