![将计算机程序中的参数/方法与文本和数学混合时的风格](https://linux22.com/image/245710/%E5%B0%86%E8%AE%A1%E7%AE%97%E6%9C%BA%E7%A8%8B%E5%BA%8F%E4%B8%AD%E7%9A%84%E5%8F%82%E6%95%B0%2F%E6%96%B9%E6%B3%95%E4%B8%8E%E6%96%87%E6%9C%AC%E5%92%8C%E6%95%B0%E5%AD%A6%E6%B7%B7%E5%90%88%E6%97%B6%E7%9A%84%E9%A3%8E%E6%A0%BC.png)
我正在编写一份文档,它是用户指南和技术手册的结合体。我描述了一个包含我通常处理的变量的系统,然后介绍了一个我编写的 R 包,该包处理一些相同的变量。我的问题是如何处理与计算机包相关的组件。对于 (1) 包的名称、(2) 函数(方法)名称和 (3) 变量/参数/参数名称:是否应该在\texttt
/\verb
样式内联和方程式中设置它们?它们应该在句子开头大写吗?或者我应该避免在句子开头使用它们?
本质上,我问的是如何排版变量和其他代码?。
答案1
这个问题没有正确答案。不过,有一个提示,选择一个惯例,定义在手册的开头清楚地说明(我的意思是真正的手把手指导)。listings
包是你编写代码的朋友,数学就是数学。避免在句子开头更改方法/函数/变量名称的大小写。