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

42

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 un nombre de función. Ahora las reglas del inglés establecen que la primera palabra en una oración necesita ser mayúscula; Sin embargo, el nombre de la función es minúscula. Si se está preguntando qué podría decirle de que la primera palabra sea el nombre de una función, tome este ejemplo:

  

Su implementación 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 escribir con 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 el inicio de la oración con el nombre de una función viola alguna regla en inglés de la que no tengo conocimiento. Edit: Realmente agradezco a todos por estas respuestas. Han cambiado y mejorado mi percepción sobre el tema. He aprendido bastante de esto. Estoy muy sorprendido de no haber pensado en estas soluciones simples pero buenas.

Creo que mi postura al alternar la oración fue demasiado dura y ahora me doy cuenta de que, debido a estas buenas respuestas, la alteración general de la oración parece ser la mejor opción para tratar estos casos, ya sea agregando paréntesis después de la función o diciendo: función antes del nombre de la función y, si está disponible, utiliza el formato para el nombre de la función.

    
pregunta user3462295 01.09.2014 - 18:29

8 respuestas

87

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

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

Dependiendo de qué tan formal sea un documento, puede adoptar el mismo enfoque. En cualquier caso, al hacerlo se 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 los comentarios y otras respuestas), agregar paréntesis a los nombres de las funciones ayuda un poco, pero como también necesitamos referirnos a entidades que no toman paréntesis, esto tiene un valor limitado. . En general, aparte de adoptar una convención de rodear el texto con caracteres especiales como corchetes y asteriscos, en el mundo del texto sin formato no hay otra opción que evitar el problema mediante la reestructuración de la oración.

    
respondido por el Reg Edit 01.09.2014 - 19:05
52

Si hay un requisito absoluto para comenzar cada oración con un límite, simplemente reemplaza fread con "La función fread " donde sea que comience una oración.

    
respondido por el x-code 01.09.2014 - 22:45
21

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

  

Su implementación fread () está rota. fread () necesita devolver cómo   se leyeron muchos bytes.

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

("posiblemente" porque podríamos argumentar 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 qué son.

    
respondido por el GreenAsJade 02.09.2014 - 09:54
10

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

  

La función fread […]

     

El método fread […]

     

La propiedad breadColor […]

    
respondido por el David Sergey 01.09.2014 - 23:06
8

Puedes comparar esto con las matemáticas en línea en las publicaciones. Rara vez verá oraciones que comiencen con una variable u otra matemática en línea.

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

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

    
respondido por el Lukas 02.09.2014 - 02:26
3

La página de manual de Linux man para fread (3) que otros enlazaron es una excelente Ejemplo de cuatro soluciones comunes.

  1. Comience su oración con "La función foo" o "La función foo". "La función fread debe volver ..." .
  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íos, por lo que "fread () necesita regresar ..." .
  3. Use tipografía (negrita, caracteres de ancho fijo o cursiva) para resaltar el nombre de la función, ya que " 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. Así que "fread (3) necesita volver ..."

Los cuatro hackers podrán reconocer instantáneamente los cuatro enfoques, y deberías poder elegir uno que coincida con el estilo de tu casa o tu 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 backticks. (Supongo que esto es una combinación de las opciones 2 y 3.)

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

    
respondido por el dcorking 03.09.2014 - 15:44
2

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

  

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

Simplemente reemplace la primera parada completa (Período) con un punto y coma:

  

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

    
respondido por el EdHunter 02.09.2014 - 09:23
0

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

En la gramática del inglés adecuada, la conclusión es esta: a veces, a los nombres propios se les dan nombres que no comienzan con una letra mayúscula, y en la mayoría de los casos, están tan unidos como no se escriben con mayúsculas como "normales". Los sustantivos están en mayúsculas. En tales casos, que ciertamente incluirían la mayoría de los nombres de funciones en idiomas descendientes con C, absolutamente no escribe mayúsculas en el nombre, incluso al principio de una oración. De hecho, es una mala gramática y ortografía en inglés 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 se supone que un nombre propio no se escribe con mayúscula por defecto, y aún así puede ser (y debería ser) cuando se usa al principio de una oración. El nombre del lenguaje brainfuck es un ejemplo de esto. Las funciones en lenguajes C-descendientes 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 este último, no al 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 mayúsculas especificados por el usuario, en algún nivel u otro.

Además, a pesar de que las reglas en inglés están escritas en piedra en este caso, tienden a ser un poco confusas alrededor de este tipo de cosas en general. El inglés no se diseñó con cosas como estas en mente, así que para otras cosas como éstas, hay espacio para la improvisación.

    
respondido por el Panzercrisis 04.09.2014 - 00:24

Lea otras preguntas en las etiquetas