Google 代码美化指南 [关闭]

Posted 2023-02-24

【中文标题】Google 代码美化指南 [关闭]

【英文标题】：Guidelines for Google Code Prettify [closed]

【发布时间】：2017-06-19 13:14:12

【问题描述】：

我希望从 Google 的 Code-Prettify 项目中获取 Issue 295；即添加对lang-powershell的支持。

虽然我找到了一些代码示例，但我找不到任何关于如何编写此代码的文档或任何提交指南（例如，语法高亮是否适用于无效代码，或者它是否应该尝试高亮此类错误） ?

具有讽刺意味的是，我尝试过谷歌搜索，但没有任何乐趣。我能找到的最好的是他们的Style Guide。

问题

请有人指点我向 Google Code Prettify 提交新语言支持脚本的文档？

【问题讨论】：

（打开一个问题以提出对缺乏文档的担忧：github.com/google/code-prettify/issues/493）

【参考方案1】：

语法高亮是否适用于无效代码 还是应该尝试突出显示此类错误

Prettify 通常应用于代码片段，因此您可以假设片段从令牌边界开始，但不应假设它从***生产开始。

在 SO 之类的网站上，prettify 应用于由熟悉其他语言并试图对现有的 sn-p 代码进行现场编辑的新手和维护者编写的输入。

Prettify 应该让对语言有深入了解的人可以轻松快速地扫描代码 sn-p 中的问题。

您应该尽最大努力从错误中恢复。例如，如果 sn-p 仅包含单行标记，那么一行上的无效标记不应妨碍对后续每一行进行美化。如果这是不可避免的，那么无效的令牌不应该阻止美化以前的令牌——查看令牌化失败的地方可以向扫描代码 sn-p 以查找问题的人传达有用的信息。

如果你想找出明显的错误，比如未闭合的字符串文字，那就太好了。我会应用.err，然后想要应用红色下划线的样式可以这样做。我很乐意为此接受对默认样式表的更改。

---

我的想法是，美化弥合了两种语言概念之间的鸿沟：

在解析器理论中，“语言”是一组字符串。 PowerShell 语言是由规范文档中的语法定义的字符串集。 在常见的描述性用法中，“语言”将相关语言社区中的说话者或作者产生的内容与他们产生字符串时的想法联系起来。当程序员坐下来编写 PowerShell 脚本时，他们生成的只是语言中的字符串，即使他们做得不好，或者他们的 PowerShell 心智模型与规范文档有很大不同。

在第一个意义上，不存在格式错误的 PowerShell 程序之类的东西，只是一个不在语言中的字符串，因此没有符合规范的语义。第二种，格式错误的 PowerShell 程序就是 PowerShell 程序。

请记住第二个定义，并记住 prettify 不需要处理代码生成器的输出。