Google Common Lisp 风格指南

ゝ一世哀愁。 2022-09-19 00:15 164阅读 0赞

# Google Common Lisp 风格指南 #

[Google Common Lisp Style Guide Rev. 1.23][] in Chinese. License: [CC-By 3.0][].

修订版号 1.23

Robert Brown[François-René Rideau][Fran_ois-Ren_ Rideau] 纪念 Dan Weinreb

模式意味着“我的语言不够用了。” ── Rich Hickey

每个风格要点都附有总结，包含了额外可用的信息，通过按下风格要点下方的箭头按钮 ▽ 来显示总结： 按下这大大的箭头按钮，来显示本指南内所有的总结：

▽ 全部展开

<table style="border-collapse:collapse; margin-top:2em; margin-bottom:2em"> 
 <tbody> 
  <tr> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%85%83%E6%BA%96%E5%89%87" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">元準則</a> 
    </div> </td> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%BF%85%E9%A1%BB%E3%80%81%E5%BA%94%E8%AF%A5%E3%80%81%E5%8F%AF%E8%83%BD%E3%80%81%E5%88%AB" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">必须、应该、可能、别</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E8%AE%B8%E5%8F%AF%E4%B8%8E%E8%B0%85%E8%A7%A3" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">许可与谅解</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E6%83%AF%E4%BE%8B" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">惯例</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%8F%A4%E8%80%81%E4%BB%A3%E7%A0%81" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">古老代码</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E6%9C%AA%E6%9D%A5%E8%AE%AE%E9%A2%98" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">未来议题</a></span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E9%80%9A%E7%94%A8%E5%87%86%E5%88%99" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">通用准则</a> 
    </div> </td> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%8E%9F%E5%88%99" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">原则</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E4%BC%98%E5%85%88%E7%BA%A7" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">优先级</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E6%9E%B6%E6%9E%84" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">架构</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E4%BD%BF%E7%94%A8%E5%87%BD%E5%BC%8F%E5%BA%93" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">使用函式库</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%BC%80%E6%BA%90%E4%BB%A3%E7%A0%81" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">开源代码</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%BC%80%E5%8F%91%E8%BF%87%E7%A8%8B" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">开发过程</a></span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E6%A0%BC%E5%BC%8F%E5%8C%96" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">格式化</a> 
    </div> </td> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E6%8B%BC%E5%86%99%E4%B8%8E%E7%BC%A9%E5%86%99" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">拼写与缩写</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E8%A1%8C%E9%95%BF" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">行长</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E7%BC%A9%E6%8E%92" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">缩排</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E6%96%87%E4%BB%B6%E8%A1%A8%E5%A4%B4" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">文件表头</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%9E%82%E7%9B%B4%E7%A9%BA%E9%97%B4" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">垂直空间</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E6%B0%B4%E5%B9%B3%E7%A9%BA%E9%97%B4" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">水平空间</a></span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E6%96%87%E6%A1%A3" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">文档</a> 
    </div> </td> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E9%92%9C%E7%BB%86%E9%9D%A1%E9%81%97" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">钜细靡遗</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%88%86%E5%8F%B7%E6%B3%A8%E8%A7%A3" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">分号注解</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E6%A0%87%E7%82%B9%E4%B8%8E%E6%96%87%E6%B3%95" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">标点与文法</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%B0%8F%E5%BF%83%E6%B3%A8%E6%84%8F" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">小心注意</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E7%89%B9%E5%AE%9A%E9%A2%86%E5%9F%9F%E8%AF%AD%E8%A8%80" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">特定领域语言</a></span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%91%BD%E5%90%8D" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">命名</a> 
    </div> </td> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E7%AC%A6%E5%8F%B7%E5%87%86%E5%88%99" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">符号准则</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E8%A1%A8%E6%98%8E%E7%9B%AE%E7%9A%84%EF%BC%8C%E8%80%8C%E9%9D%9E%E5%86%85%E5%AE%B9" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">表明目的，而非内容</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%85%A8%E5%B1%80%E5%8F%98%E9%87%8F%E4%B8%8E%E5%B8%B8%E9%87%8F" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">全局变量与常量</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%88%A4%E6%96%AD%E5%BC%8F%E5%90%8D%E7%A7%B0" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">判断式名称</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%BF%BD%E7%95%A5%E5%87%BD%E5%BC%8F%E5%BA%93%E5%89%8D%E7%BC%80" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">忽略函式库前缀</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%8C%85" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">包</a></span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E8%AF%AD%E8%A8%80%E4%BD%BF%E7%94%A8%E5%87%86%E5%88%99" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">语言使用准则</a> 
    </div> </td> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E4%BB%A5%E5%87%BD%E6%95%B0%E5%BC%8F%E9%A3%8E%E6%A0%BC%E4%B8%BA%E4%B8%BB" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">以函数式风格为主</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E9%80%92%E5%BD%92" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">递归</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E7%89%B9%E6%AE%8A%E5%8F%98%E9%87%8F" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">特殊变量</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E8%B5%8B%E5%80%BC" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">赋值</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E6%96%AD%E8%A8%80%E4%B8%8E%E6%9D%A1%E4%BB%B6%E5%BC%8F" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">断言与条件式</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E7%B1%BB%E5%9E%8B%E6%A3%80%E6%9F%A5" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">类型检查</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#Common_Lisp_%E5%AF%B9%E8%B1%A1%E7%B3%BB%E7%BB%9F" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">Common Lisp 对象系统</a></span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%85%83%E8%AF%AD%E8%A8%80%E5%87%86%E5%88%99" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">元语言准则</a> 
    </div> </td> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%AE%8F" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">宏</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E4%BD%95%E6%97%B6%E6%B1%82%E5%80%BC" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">何时求值</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E8%AF%BB%E5%8F%96%E6%9C%9F%E6%B1%82%E5%80%BC" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">读取期求值</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E6%B1%82%E5%80%BC" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">求值</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%AF%BC%E5%85%A5%E4%B8%8E%E5%AF%BC%E5%87%BA" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">导入与导出</a></span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E8%A1%A8%E7%A4%BA%E6%95%B0%E6%8D%AE" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">表示数据</a> 
    </div> </td> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#NIL:_%E7%A9%BA%E8%A1%A8%E3%80%81%E5%81%87%E3%80%81%E4%BB%A5%E5%8F%8A%E6%88%91%E4%B8%8D%E7%9F%A5%E9%81%93" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">NIL: 空表、假、以及我不知道</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%88%AB%E6%BB%A5%E7%94%A8%E5%88%97%E8%A1%A8" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">别滥用列表</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%88%97%E8%A1%A8_x_%E7%BB%93%E6%9E%84_x_%E5%A4%9A%E5%80%BC" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">列表 x 结构 x 多值</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%88%97%E8%A1%A8_x_%E7%82%B9%E5%AF%B9" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">列表 x 点对</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%88%97%E8%A1%A8_x_%E6%95%B0%E7%BB%84" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">列表 x 数组</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%88%97%E8%A1%A8_x_%E9%9B%86%E5%90%88" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">列表 x 集合</a></span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E9%80%82%E5%BD%93%E5%BD%A2%E5%BC%8F" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">适当形式</a> 
    </div> </td> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%AE%9A%E4%B9%89%E5%B8%B8%E9%87%8F" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">定义常量</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%AE%9A%E4%B9%89%E5%87%BD%E6%95%B0" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">定义函数</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E6%9D%A1%E4%BB%B6%E8%A1%A8%E8%BE%BE%E5%BC%8F" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">条件表达式</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%90%8C%E4%B8%80%E6%80%A7_x_%E7%9B%B8%E7%AD%89%E6%80%A7_x_%E6%AF%94%E8%BE%83" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">同一性 x 相等性 x 比较</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E8%BF%AD%E4%BB%A3" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">迭代</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E8%BE%93%E5%85%A5%E4%B8%8E%E8%BE%93%E5%87%BA" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">输入与输出</a></span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E4%BC%98%E5%8C%96" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">优化</a> 
    </div> </td> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E9%81%BF%E5%85%8D%E9%85%8D%E7%BD%AE" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">避免配置</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%8D%B1%E9%99%A9%E6%93%8D%E4%BD%9C" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">危险操作</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%8A%A8%E6%80%81%E8%8C%83%E5%9B%B4" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">动态范围</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%BA%94%E7%94%A8_x_%E5%8C%96%E7%AE%80" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">应用 x 化简</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E9%81%BF%E5%85%8D_NCONC" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">避免 NCONC</a></span> 
    </div> </td> 
  </tr> 
  <tr> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E9%99%B7%E9%98%B1" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">陷阱</a> 
    </div> </td> 
   <td style="border-width:2px 6px; border-style:solid; border-color:rgb(204,204,204); padding:2px 20px; font-size:12pt"> 
    <div style="font-size:12pt; padding-top:0.35em; padding-bottom:0.35em"> 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%87%BD%E6%95%B0_FUN?_%E5%BC%95%E7%94%A8_FUN?" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">函数 FUN? 引用 FUN?</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E8%B7%AF%E5%BE%84%E5%90%8D" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">路径名</a></span>&nbsp; 
     <span style="padding-right:1em; white-space:nowrap"><a href="http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E6%BB%A1%E8%B6%B3" style="border-bottom-style:dashed; border-bottom-width:1px; border-bottom-color:rgb(17,126,198); margin:0px 2px; color:rgb(17,126,198); text-decoration:none" rel="nofollow">满足</a></span> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

## 重要注意事项 ##

### 注意：显示在本指南里所隐藏的信息 ###

[link][] ▽

这个风格指南包含了许多表面上看不到的细节。他们由三角图示标记，可以在左边看到。按下它。你应该看到“万岁”出现在下方。

万岁！现在你知道如何将点展开来获得更多细节。在文件的最上方也有一个“全部展开”的按钮。

## 背景 ##

Common Lisp 是一个强大的多范式程序语言。能力越强，责任越大。

本指南推荐了格式化及风格化的选择，目的在于使你的代码更容易被其他人理解。针对我们在 Google 开发的内部应用及免费软件函式库，在改动之前你得先遵循这些准则。但是要注意的是，每个项目有自己的一套规则及惯例，违反或覆写了这些通用的准则；比如速度导向的 QPX 低费率搜索引擎就与 QRes 订位系统有着大相迳庭的风格。

如果你在 Google 以外的地方编写 Common Lisp 代码，我们邀请你一同来思考这些准则。在不与你自身优先考量起冲突的前提上，你可能会发现某些准则是很有用的。我们欢迎你评论及提供建设性的反馈，讨论如何改善这篇指南，并提供其它成功案例的风格。

本指南不是一个 Common Lisp 教程。关于语言的基本信息，请查阅 [Practical Common Lisp][] 。关于语言参考手册，请查阅 [Common Lisp HyperSpec][] 。 至于更详细的风格指南，姑且看看 Peter Norvig 与 Kent Pitman 写的 [风格指南][Link 1] 。

## 元準則 ##

### 必须、应该、可能、别 ###

[link][link 1] ▽

每一个准则的重要程度，由下列来自 [RFC 2119][] 的关键字及词组标示。

<table style="border-collapse:collapse; margin-top:2em; margin-bottom:2em"> 
 <tbody> 
  <tr> 
   <th style="border:2px solid rgb(204,204,204); padding:2px 20px; font-size:12pt"> 必须 MUST</th> 
   <td style="border:2px solid rgb(204,204,204); padding:2px 20px; font-size:12pt"> <p style="line-height:1.75em">MUST 或是 “REQUIRED”、“SHALL”，代表这是一个绝对得做的事儿。你必须徵询许可来违反一个 MUST。</p> </td> 
  </tr> 
  <tr> 
   <th style="border:2px solid rgb(204,204,204); padding:2px 20px; font-size:12pt"> 绝对不要 MUST NOT</th> 
   <td style="border:2px solid rgb(204,204,204); padding:2px 20px; font-size:12pt"> <p style="line-height:1.75em">MUST NOT，或是 “SHALL NOT”，代表这是绝对不能做的事儿，你必须徵询许可来违反一个 MUST NOT。</p> </td> 
  </tr> 
  <tr> 
   <th style="border:2px solid rgb(204,204,204); padding:2px 20px; font-size:12pt"> 推荐 SHOULD</th> 
   <td style="border:2px solid rgb(204,204,204); padding:2px 20px; font-size:12pt"> <p style="line-height:1.75em">SHOULD，或是形容词 “RECOMMENDED”，代表在特殊情况下也许有适当的理由可以违反准则的要求，但必须了解所有会影响到的事情，在选择另一个主题前审慎衡量。你必须徵询谅解来违反一个 SHOULD。</p> </td> 
  </tr> 
  <tr> 
   <th style="border:2px solid rgb(204,204,204); padding:2px 20px; font-size:12pt"> 不推荐 SHOULD NOT</th> 
   <td style="border:2px solid rgb(204,204,204); padding:2px 20px; font-size:12pt"> <p style="line-height:1.75em">SHOULD NOT，或是片语 “NOT RECOMMENDED”，代表在特殊情况下也许有适当的理由可以违反准则的要求，但必须了解所有会影响到的事情，在选择另一个主题前审慎衡量。你必须徵询谅解来违反一个 SHOULD NOT。</p> </td> 
  </tr> 
  <tr> 
   <th style="border:2px solid rgb(204,204,204); padding:2px 20px; font-size:12pt"> 选择性 MAY</th> 
   <td style="border:2px solid rgb(204,204,204); padding:2px 20px; font-size:12pt"> <p style="line-height:1.75em">MAY，或是形容词 “OPTIONAL”，代表某件事做不做完全取决于你。</p> </td> 
  </tr> 
 </tbody> 
</table>

与 RFC 不同，我们在使用上列关键字时，不会将他们都转成大写。

（译注：中文无法使用这些关键字，我尽力斟酌了行文中的口气，来达到效果。）

### 许可与谅解 ###

[link][link 2] ▽

有时候违反某些准则是有用甚至是必要的。在这些情况里，你必须向适当的人徵询许可或取得谅解。

许可来自于项目的负责人。

在违反准则附近用注解来请求谅解，而你的代码审查者将授予谅解。原先的注解应由你签名，而审查者应在审查时，在注解里添加一个签名许可。

### 惯例 ###

[link][link 3] ▽

必须遵守这些约定。这不是选择性的。

某些准则启发自良好的普遍编程原则。某些准则启发自 Common Lisp 的技术特性。某些准则启发自一个技术理由，但在理由消灭后，准则仍被保留了下来。某些像是注解及缩排的准则，完全是基于惯例，而不是有明显的技术价值。在任何情况下，必须遵循这些准则，以及其他常见但尚未被纳入本文件的准则。

必须要遵循惯例。惯例对于可读性来说非常重要。当惯例默认被遵循时，违反惯例是某件需要注意的事发生了，并需要留意的信号。当惯例被有组织地违反时，违反惯例会成为需要被忽略的恼人噪音。

常规惯例是一种教化。目的使你仿效社群的习俗，这样便可更有效率的与现有成员合作。分辨出哪些是启发于技术性、或仅仅是惯例的准则仍然很有用，这样你知道可以在何时违反惯例来获得好的成效，以及何时寻求准则帮助你不落入陷阱。

### 古老代码 ###

[link][link 4] ▽

编程时顺手修补老代码。

我们许多的代码都是在准则存在前所写的。平常编程遇到违反准则的代码时，修复它们。

不要在没有警告其他开发者或协调的情况下进行大量修补，也不要使合并较大的分支变得比以前困难。

### 未来议题 ###

[link][link 5] ▽

当前版本的文件没有考虑到许多额外标准化的主题，这留到之后的版本。

*  文件及目录结构
 *  包与模组化
 *  线程与锁
 *  如何添加可配置的组件
 *  CLOS 风格：initforms, 槽以及访问器名称，等等。
 *  每个类可有的最大槽数的建议。
 *  更多良好代码的具体例子：
    
     *  异常
     *  事务（含重试）
     *  XML
     *  类型
     *  封装或抽象
     *  类别及槽名
     *  等等。
 *  何时（不要）使用条件式编译：
    
     *  改动产品时
     *  条件式调试或终端输出等。
     *  “暂时性”注解掉代码块
     *  等等。

## 通用准则 ##

### 原则 ###

[link][link 6] ▽

有某些基本原则，需要软件开发团队的每个开发者铭记在心。无论什么时候，觉得详细的准则不适当、感到疑惑或是自相矛盾时，回头看看这些原则来寻求指导：

*  每一个开发者所写的代码必须让别的开发者容易阅读、理解及改动 ──── 即便最初的开发者已经不在了。（这是 “hit by a truck” 理论。）
 *  大家的代码看起来要一致。理想上，不应该看到几行代码就认出，啊，这个风格是“Fred 写的代码”。
 *  追求精准。
 *  追求简洁。
 *  KISS 原则（Keep It Simple, Stupid），简单就是美。
 *  杀鸡焉用牛刀，用最适当的工具。
 *  使用常识。
 *  相关代码放在一起。将别人需要理解一部分代码所需的画面跳转减到最低。

### 优先级 ###

[link][link 7] ▽

当抉择如何写出一段给定的代码时，依此优先序追求下列性质：

*  客户的易用性。
 *  可调试性或可测试性。
 *  可读性或可理解性。
 *  可扩充性或可修改性。
 *  （运行期 Lisp 代码的）效率。

这些准则大部分都是直观的。

客户的易用性代表系统满足了客户的需求；如：需要处理客户的交易量，正常运作时的需求等等。

针对 Lisp 效率这一点，若是有两个同样复杂的选择，选运行较好的那个。（通常是构造比较少的那个，也就是从堆上配置了较少空间。）

给定两个选择，其中一个比另一个复杂，选择简单的那个，并分析出另一个有更好效能时，才重新审视当初的决定。

然而，避免过早优化。别为了给不常用到的代码提升速度而使复杂度上升。因为长期来说，鲜少运行的代码快不快不是那么重要。

### 架构 ###

[link][link 8] ▽

要打造强韧且易维护的代码，这关系到如何将代码切分成组件，这些组件如何沟通，改版时这些改动如何传递。而最重要的是，程序员在改版时如何使这些组件互相沟通良好。

如果你的工作会影响到其他的小组，或是可被小组之间重用，比如添加新组件会影响到其他小组（包括品管及运维），或是非本地作业的事情，在开始写代码前 ── 你必须至少写几段文字说明一下，并获得设计组或其他相关当事人的许可，不然在他们拒绝之后，准备好重头开始吧。

如果你不知道或不在乎这些议题，问问某些知道或在乎的人。

### 使用函式库 ###

[link][link 9] ▽

通常最简单的办法是使用已存在的函式库。或还没存在的函式库。没有函式库的情况，我们鼓励你开发一个这样的函式库，但首先得未雨稠缪。

*  绝对不要贸然开始写一个新的函式库，除非你已查证没有可用的函式库存在，而新的函式库完成后可以解决或满足你的需求。这是一个违背[非我所创][Link 2]症候群的规则，这个症候群在 Lisp 黑客圈里特别常见。
 *  无论你采用是新的或古老的函式库，*必须*要获得许可，才能将第三方代码并入代码库。你必须在对的邮件组里讨论这个函式库的用途，并将你的代码交给此领域的专业人士审查，或是由（如果有的话） Lisp 函式库生态系统的人审查。并请准备好说明为什么这个特定的解决方案，比其他可用的函式库更好。
 *  某些函式库的授权，与你正撰写的软件不兼容，则绝对不要将这个函式库认为是可用的。当心授权议题，或请教相关人士。

### 开源代码 ###

[link][link 10] ▽

如果你要写一个通用的函式库，或是改动一个存在的开源函式库，欢迎你将函式库与项目分开发布，并像是用其他的开源库一样导入你的函式库。

用你的判断来分辨通用 vs 业务相关的代码，将通用的部份开源出来，而业务相关的部份保留为商业机密。

开源代码有许多好处，能促使第三方参与开发，使开发产品特色从用户角度出发，并使你诚实面对代码的品质。无论你写的是什么代码，你会需要维护他们的，并确保代码品质够好，能在产品上线时使用。开源正因为如此，不会有什么额外的负担。即便是（至少最初是如此）无法直接被第三方使用的代码。

### 开发过程 ###

[link][link 11] ▽

开发过程超出了本文件的范围。然而开发者至少应记得下列几件小事：审查代码，撰写测试，去除警告，运行测试，避免大幅改动。

*  所有的代码改动必须经过审查。应该期待你的代码会被其他黑客审查，而你也会有机会去审查别人的代码。审查的部份标准，将会是代码需要遵守这份文件所载的编码标准。
 *  你必须撰写测试，以及测试新撰写的代码，并记录你所修补的错误（bug）。每个 API 函数必须有单元测试，以及任何先前失败的例子。在前述事项做完之前，你的工作都不算完成。在评估工作任务时，必须算进撰写测试所花的时间。
 *  代码编译后必须没有任何编译错误或是警告信息，等等。如果需要忽略编译器所抱怨的警告时， 将这些警告用 `UIOP:WITH-MUFFLED-COMPILER-CONDITIONS` 与`UIOP:*UNINTERESTING-COMPILER-CONDITIONS*` 框架处理（部分是 `UIOP`，部分是 `ASDF 3`），将整个项目包起来，或是包覆单一的文件（使用 `ASDF` 的 `:around-compile`hook）。
 *  所有的代码应该在一个适当的源代码管理系统检查，该系统可以在某种形式上，允许完整重新生成，某个已经布署（或可以布署）代码的版本、测试以及执行。
 *  必须在运行测试前先测试单一的组件，只有在每个组件通过单元测试时，才可以提交代码。
 *  应该将代码覆盖度纳入你的测试流程。如果测试不能涵盖所有新更新的代码，那么测试就是不足够的；无论有任何理由，一个测试无法覆盖的代码，需要清楚标明，并附上理由。
 *  许多人在分支下开发。必须获得许可，再开始大幅度的改动。（比如大量的重新缩排）这样我们才可事先协调，并给予分支充裕的时间来回到主线上。

## 格式化 ##

### 拼写与缩写 ###

[link][link 12] ▽

必须在注解里使用正确的拼写，而最重要要拼对的是函数的形参。

当数个正确拼写同时存在时（包括美式及英式英语），而开发者之间尚未有共识存在时，你应该选择较短的拼写。

必须只使用常见与领域相关的缩写，缩写保持一致。可以把受限作用域里的词法变量缩短，来避免符号名称过长。

如果你不确定的话，查字典吧，或是 Google 下来检查拼写。或问问当地的专家。

下列是如何选择正确拼写的例子：

*  使用 "complimentary" 表示免费饮料或大餐， 而不是 "complementary"。
 *  使用 "existent" 以及 "nonexistent" 而不是 "existant"。 使用 "existence" 而不是 "existance"。
 *  使用 "hierarchy" 而不是 "heirarchy"。
 *  使用 "precede" 而不是 "preceed"。
 *  使用 "weird" 而不是 "wierd"。

下列是如何选择短的拼写的例子：

*  使用 "canceled" 而不是 "cancelled"
 *  使用 "queuing" 而不是 "queueing".
 *  使用 "signaled" 而不是 "signalled";
 *  使用 "traveled" 而不是 "travelled".
 *  使用 "aluminum" 而不是 "aluminium"
 *  使用 "oriented" 而不是 "orientated"
 *  使用 "color" 而不是 "colour"
 *  使用 "behavior" 而不是 "behaviour"

位工业标准术语或是行话破例，包括了简单的拼写错误。 比如：

*  在 HTTP 协议的上下文中，使用 "referer" 而不是 "referrer"

### 行长 ###

[link][link 13] ▽

应该要格式化你的源代码，使单行不超过 100 个字符。

有某些行长限制总比没有好。古老的文字终端机使用 80 栏，但现在允许 100 栏似乎比较好，因为好的风格鼓励你使用具有描述性的变量以及函数名称。

### 缩排 ###

[link][link 14] ▽

像配置好的 GNU Emacs 那样缩排你的代码。

审慎的缩排会使代码更容易理解。

一般 GNU Emacs 在缩排 Common Lisp 代码这件工作上表现的非常出色。也可以教会 GNU Emacs 如何缩排新定义的形式，比如给特定领域语言用的特殊规则。每个项目可能含有某些定制缩排的文件；使用它们吧。

使用缩排让复杂的函数调用变得容易阅读。当调用一行放不下，或是函数接受太多参数时，考虑在参数之间插入新行，让每个参数都在独立的一行。不插入新行在某方面使得要知道函数接受多少参数，或参数从何开始又从何结束变得困难。

;; 差劲
    (do-something first-argument second-argument (lambda (x)
        (frob x)) fourth-argument last-argument)

;; 较佳
    (do-something first-argument
                  second-argument
                  #'(lambda (x) (frob x))
                  fourth-argument
                  last-argument)

### 文件表头 ###

[link][link 15] ▽

应该在每个源文件的最上方，注明维护者及其他重要信息。

不应该在源文件里附上版权与著作权的信息。

每个源文件可以从简单描述下这个文件的内容开始。

在说明之后，每个文件应该用这个形式起步： `(in-package :package-name)`

在 `in-package` 形式之后， 接着是任何与文件相关的声明，比如 `(declaim (optimize ...))`。 这些是 `ASDF` `:around-compile` hook 并没有涵盖到的声明。

;;;; Author: brown (Robert Brown)
    
    ;;;; Variable length encoding for integers and floating point numbers.
    
    (in-package #:varint)
    (declaim #.*optimize-default*)

不应该在文件顶端放著作权信息，著作权信息可以通过版本控制与 `OWNERS` 来取得。

不应该在每个源代码文件附上版权信息。单独发布的文件例外。

每个项目或函式库有个单一的文件，详细说明文件的授权。 没有授权或版权代表这个项目是[专有代码][Link 3]。

### 垂直空间 ###

[link][link 16] ▽

垂直空间：顶层级别的形式，一个空行。

应该在顶层级别的形式留一个空行，比如函数定义。在特殊情况下，空行可以省略，简单的、密切相关的、同种类的定义形式，比如一组相关的类型声明，或是常量定义。

(defconstant +mix32+ #x12b9b0a1 "pi, an arbitrary number")
    (defconstant +mix64+ #x2b992ddfa23249d6 "more digits of pi")
    
    (defconstant +golden-ratio32+ #x9e3779b9 "the golden ratio")
    (defconstant +golden-ratio64+ #xe08c1d668b756f82 "more digits of the golden ratio")
    
    (defmacro incf32 (x y)
      "Like INCF, but for integers modulo 2**32"
      `(setf ,x (logand (+ ,x ,y) #xffffffff)))
    (defmacro incf64 (x y)
      "Like INCF, but for integers modulo 2**64"
      `(setf ,x (logand (+ ,x ,y) #xffffffffffffffff)))

空行可以把复杂的函数切分成多个部分。一般来说，你应该要把大函数切成几个小函数，而不是添加垂直空间，让它读起来比较好读。如果你不能够切成小函数，你应该要使用 `;;` 注解，说明每个函数的部分各是干嘛的。

应该要努力保留顶层形式（含注解），但文档字串最好保持简短。超过一页的顶层形式很少见，有这种情况的话，确定用途是正当的。这也可以应用到 `eval-when` 里的形式，而不是限制 `eval-when` 这个形式。另一方面，`defpackage` 可能更长，因为可能含有长长的符号列表。

每个顶层形式应该要少于 61 行，包含注解，但文档字串不算在内。这是用于在 `eval-when` 里的每个形式，而不是 `eval-when` 本身。另外 `defpackage` 可以超過 61 行，因为它可能有长长的列表清单。

### 水平空间 ###

[link][link 17] ▽

水平空间：括弧之间不要有空格、tab。

绝对不要在括号或符号的前面或后面加上额外的空白。

绝对不要把右括号单写在一行。一组连续的尾随括号必须出现在同一行。

;; 非常差劲
    ( defun factorial ( limit )
      ( let (( product 1 ))
        ( loop for i from 1 upto limit
              do (setf product ( * product i ) ) )
        product
      )
    )

;; 较佳
    (defun factorial (limit)
      (let ((product 1))
        (loop for i from 1 upto limit
              do (setf product (* product i)))
        product))

形式之间应该只用一个空格。

你不应该在多行连续的中间，使用空格来垂直排列形式。一个例外是当代码不垂直对齐，就看不出你要强调的重要性时。

;; 差劲
    (let* ((low    1)
           (high   2)
           (sum    (+ (* low low) (* high high))))
      ...)

;; 较佳
    (let* ((low 1)
           (high 2)
           (sum (+ (* low low) (* high high))))
      ...))

你必须排列嵌套形式，如果他们超过一行的话。

;; 差劲
    (defun munge (a b c)
    (* (+ a b)
    c))

;; 较佳
    (defun munge (a b c)
      (* (+ a b)
         c))

惯例是一个绑定形式的主体，在第一行之后缩排两格。 任何在主体之前的绑定数据，通常缩排四格。 函数调用的参数与第一个参数对齐； 如果第一个参数自成一行， 则与函数名称对齐。

(multiple-value-bind (a b c d)
        (function-returning-four-values x y)
      (declare (ignore c))
      (something-using a)
      (also-using b d))

可有单独括号的例外献给数个定义之间的`eval-when` 形式； 在这个情况下，在闭括号附上一个注解 `; eval-when`。

必须设置好编辑器，使你在编辑文件时，避免插入 tab 字符。当编辑器不同意一个 Tab 是由几个空格代表时，Tab 会使你困惑。在 Emacs，输入 `(setq-default indent-tabs-mode nil)`。

## 文档 ##

### 钜细靡遗 ###

[link][link 18] ▽

所有可视函数都应该要使用文档字串，来解释如何使用你的代码。

除非某段代码完全一目了然，不然就上一个文档字串（别名 docstring）。

文档字串生来就是给使用代码的程序员读的。他们可以从函数、类型、类别、变量以及宏取出， 并通过编程工具，如 IDE 来显示。或是通过在 REPL 下查询，如 `(describe 'foo)`；放在网上的文档或其他参考着作也可以在文档字串的基础上来创建。因此，文档字串是给你的 API 撰写文档的完美地点。应该描述如何使用代码（包括需要避开的陷阱），而不是代码是如何工作的（以及之后所需的工作），这两个是你该放在注解的东西。

当定义一个顶层及别的函数、类型、类别、变量以及宏时，提供一个文档字串。一般则是在程序语言允许加入文档的地方，添加文档字串。

关于函数，docstring 应该要描述函数的合约： 这个函数干什么， 这个函数的参数表示什么， 这个函数所返回的值， 这个函数可捕捉的状况。 应该在适当的抽象层级上来表达，解释意图，而不仅是解释语法。在文档字串里，将 Lisp 符号的名字转为大写，比如函数参数。打个比方，"The value of LENGTH should be an integer."

(defun small-prime-number-p (n)
      "Return T if N, an integer, is a prime number. Otherwise, return NIL."
      (cond ((or (< n 2))
             nil)
            ((= n 2)
             t)
            ((divisorp 2 n)
             nil)
            (t
             (loop for i from 3 upto (sqrt n) by 2
                   never (divisorp i n)))))

(defgeneric table-clear (table)
      (:documentation
        "Like clrhash, empties the TABLE of all
        associations, and returns the table itself."))

一个长的 docstring 通常用一句话的总结开始是有用的，接着才是 docstring 的主要内容。

当一个类型的名称被使用时，符号可以用反引号及单引号包围，反引号在前，单引号在后。Emacs 会将类型高亮，而高亮会变成读取器的线索， M-. 会跳转到符号的定义。

(defun bag-tag-expected-itinerary (bag-tag)
      "Return a list of `legacy-pnr-pax-segment' objects representing
      the expected itinerary of the `bag-tag' object, BAG-TAG."
      ...)

当特化影响了方法的行为，超出通用函数的 docstring 所描述的内容时，应该给通用函数的每一个方法各自撰写文档。

当你修补了一个错误，思考看看修补后的代码是否正确，还是是错误的；如果不对的话，你必须添加一个注解， 从修补错误的观点来解释代码。如果可以的话，添加错误序号，也是推荐的。

### 分号注解 ###

[link][link 19] ▽

你必须使用正确数量的分号来写注解。

注解是给未来维护代码的人的说明。即便你是唯一能够看与接触到代码的人，即便你长生不老或是永远不离职，或是离职之后根本不管的人（并在这种万一的情况下使你的代码自行毁灭），你可能会发现给代码写注解是有帮助的。当然啦，在几个礼拜、月、年之后，回头看看代码时，你会发现当初写这个代码的人，完全与你不是同一个人，则你会感激当初自己有留下注解。

你必须给任何复杂的代码留注解，这样一来下个开发者才可以了解情况。（又来了，“hit by a truck” 理论。）

注解也可以作为指引阅读代码的人的一种方式，这样他们才知道这里有什么。

*  文件表头及源文件里大段代码的重要注解，注解应该使用四个分号。
 *  一个顶层级别的形式或是小组的顶层级别形式，注解应该使用三个分号。
 *  在一个顶层级别的形式里，如果注解出现在行之间，注解应该使用两个分号。
 *  如果是一个括号的备注且出现在行的最后，注解应该使用一个分号。你应该使用空格来分离注解与引用的代码，使得注解脱颖而出。你应该试着垂直排列相关的行尾注解。

;;;; project-euler.lisp
    ;;;; File-level comments or comments for large sections of code.
    
    ;;; Problems are described in more detail here:  http://projecteuler.net/
    
    ;;; Divisibility
    ;;; Comments that describe a group of definitions.
    
    (defun divisorp (d n)
      (zerop (mod n d)))
    
    (defun proper-divisors (n)
      ...)
    
    (defun divisors (n)
      (cons n (proper-divisors n)))
    
    ;;; Prime numbers
    
    (defun small-prime-number-p (n)
      (cond ((or (< n 2))
             nil)
            ((= n 2)   ; parenthetical remark here
             t)        ; continuation of the remark
            ((divisorp 2 n)
             nil)  ; different remark
            ;; Comment that applies to a section of code.
            (t
             (loop for i from 3 upto (sqrt n) by 2
                   never (divisorp i n)))))

在分号与注解文字之间，应该留一个空格。

### 标点与文法 ###

[link][link 20] ▽

应该使用正确的标点符号来撰写文档。

当注解是一个完整的句子时，应该将第一个字大写，并用一个句号结束注解。普遍来说，你应该使用正确的标点符号。

### 小心注意 ###

[link][link 21] ▽

对于需要特别注意的代码，必须遵循使用 TODO 注解的规范。 针对使用了晦涩形式的代码，必须要加上注解。

对于需要特别留意的注解，像是未完成的代码、待办事项、问题、损坏及危险， 加上一个 TODO 注解指出问题的类型及本质，以及其他需要注意的事项。

TODO 注解的格式，由 TODO （全大写）开始，接着是括号，括号内是你的邮箱或是其他人，再来是一个冒号跟空格，以及额外需要完成或想要完成的工作说明。包含在此注解内的用户名，是理解这个缺陷的那个人。TODO 注解并不代表一定要修补问题。

当给注解签名时，应该使用用户名（针对公司内部代码），或是完整 email 地址（针对公司外部可见代码），而不只是名字的首字母缩写。

;;--- TODO(george@gmail.com): Refactor to provide a better API.

在 TODO 注解里，具体指出时间或是软件版本：

;;--- TODO(brown): Remove this code after release 1.7 or before November, 2012.

对于使用了晦涩形式来完成工作的代码，必须加上注解叙述晦涩形式的用途， 以及晦涩形式完成了什么工作。

### 特定领域语言 ###

[link][link 22] ▽

你应该给 DSL 及任何在 DSL 里的简短程序写文档。

应该设计出同行容易阅读及理解的特定领域语言。

必须正确地给你的 DSL 写文档。

有的时候，你的 DSL 设计的相当简洁。 在这个情况里，如果每个程序从上下文中不是很直观的话， 用文档说明每个程序干了什么是很重要的。

值得注意的是，当使用正则表达式时（比如使用 `CL-PPCRE` 包），永远记得要留一条注解（通常在前一行加两个分号的注解），（最起码）要解释正则表达式做了什么，或是目的为何。注解不需要解释语法的所有细节，但应该让别人不需要解析正则表达式，就能理解你代码的逻辑是什么。

## 命名 ##

### 符号准则 ###

[link][link 23] ▽

使用小写。 遵循 [拼写与缩写一节][Link 4]的惯例。 遵循标点符号的惯例。

所有的符号使用小写。一致地使用小写，除了可读性更高之外，也让查找符号名变得更容易。

注意 Common Lisp 会自动转换大小写，而对一个符号调用 `symbol-name` 时，会返回大写。由于这个转换大小写的特色，当你试着要分辨符号的大小写时，最终只会让你陷入困惑。但使用逃脱字符也是可以强迫符号成为小写的，不过你不应该使用这个功能，除非你需要与第三方软件协同操作。

在符号的单词之间放连字符。如果你不能很简单的说出标识符的名字，那符号大概命名的很差劲。

连字符必须用 `"-"`，不要用 `"/"` 或是 `"."`。除非你有一个无懈可击的理由，以及你的提议取得了来自其他黑客的许可。

参考[拼写与缩写][Link 4]一节，以了解使用缩写的准则。

;; 差劲
    (defvar *default-username* "Ann")
    (defvar *max-widget-cnt* 200)

;; 较佳
    (defvar *default-user-name* "Ann")
    (defvar *maximum-widget-count* 200)

Common Lisp 在符号内使用标点符号是有惯例的。不应该在这些惯例之外，在符号内使用标点符号。

除非变量的作用域非常小，不要使用过短的名字，像是：`i` 以及 `zq`。

### 表明目的，而非内容 ###

[link][link 24] ▽

将变量用目的命名，而不是变量的内容。

应该根据变量所意涵的概念命名，而不是根据概念在机器底层是怎么表示的来命名。

因此，你应该避免嵌入数据结构或结合类型名称，比如将 `list`, `array`，或是 `hash-table` 嵌入变量名，除非你正在写一个通用的演算法，适用于任何的列表、数组、哈希表，等等。在这个情况下，变量名有 `list` 或 `array`是完全没问题的。

当然啦，无论何时你有创造新种对象的目的时，应该使用 `DEFCLASS` 或 `DEFTYPE`，来引入新的抽象数据类型，操作这些对象的函数，可以通用地使用反映出抽象类型的名称。

举例来说，如果一个变量的值，总是一个 row（或是 `NIL`），叫它 `row`或 `first-row` 是很好的，或者是其他相似的名字。`row` 被 `DEFTYPE`定义成 `STRING` 是没问题的。严格来说，因为你将细节抽象起来了，剩下的亮点是，它是一个 row。在这个上下文里，不应该将变量取名为 `STRING`，除非底层函数明确地操作 row 的内部结构，提供与 STRING 类似的抽象。

保持一致。如果变量在一个函数里命名成 `row`，且它的值被传给第二个函数，则将其称为 `row` 而不是 `value`。（这是一个实际情况）

### 全局变量与常量 ###

[link][link 25] ▽

根据惯例来命名全局变量。

全局常量名应由加号开始，并以加号结束。

全局变量名应由星号开始，并以星号结束（在这个上下文里，星号又称为耳套「earmuffs」）。

在某些项目里，参数在普通情况下，通常不会被绑定或改动（但也许某些实验或例外情况会），应用一个钱号开始（但非钱号结束）。如果这样的惯例在你的项目里存在的话，应该一致地遵守。否则，应该避免这样子命名变量。

Common Lisp 没有全局词法变量，所以命名惯例是确保全局变量会被动态绑定，以及不会与局部变量名称重复。要捏造一个全局词法变量也是有可能的，只要有 `DEFINE-SYMBOL-MACRO`以及用不同的方式命名全局变量。不应该使用这个技巧，除非你先发布一个函式库将它抽象起来。

(defconstant +hash-results+ #xbd49d10d10cbee50)
    
    (defvar *maximum-search-depth* 100)

### 判断式名称 ###

[link][link 26] ▽

判断式函数与变量的名字以 `"P"` 结尾。

你应该将返回布尔值的函数与变量的 结尾以 `"P"` 或 `"-P"` 命名， 来表示他们是判断式。 一般来说，你应该使用， 函数名是一个单词时，使用 `"P"`； 超过一个单词时，使用 `"-P"`。

这个惯例的理由在 [the CLtL2 chapter on predicates][] 给出。

为了要统一，你应该遵循上面的惯例， 而不是下面其中一个替代方案。

一个替代规则是，在某些已存在的包， 总是使用 `"-P"`。 另一个替代规则是，在某些已存在的包， 总是使用 `"?"`。 当你开发一个包时，你必须要与其它的包保持一致。 当你开始一个新包时，在没有非常充分记录你的理由之前， 你应该不要使用这些替代规则，

### 忽略函式库前缀 ###

[link][link 27] ▽

符号名不应该纳入一个函式库或包的前缀。

当在包里命名（内部或外部）符号时， 你不应该将包的名称作为前缀含在符号里。 这样命名符号，让访问这个包的人， 必须使用包前缀来修饰，这样是很尴尬的。 （一次是包的前缀、另一次是符号名的前缀）。

;; 差劲
    (in-package #:varint)
    (defun varint-length64 () ... )
    
    (in-package #:client-code)
    (defconst +padding+ (varint:varint-length64 +end-token+))

;; 较佳
    (in-package #:varint)
    (defun length64 () ... )
    
    (in-package #:client-code)
    (defconst +padding+ (varint:length64 +end-token+))

上述规则的一个例外会是给变量名加入前缀， 不然就会与使用当前这个包的人起冲突的情况。 举例来说，`ASDF` 导出一个变量叫做 `*ASDF-VERBOSE*`， 这个变量只受唠叨的 ASDF 控制，而不是整个 Lisp 程序。

### 包 ###

[link][link 28] ▽

适当地使用包。

Lisp 的包用来划分命名空间。 通常每个系统有独立的命名空间。 一个包有一组导出的符号， 目的就是给包外部的人用的， 允许其它的模组使用模组内的实用函数。

包的内部符号应该永远不可以被其它的包引用。 也就是说，你应该永远不需要使用两个冒号 `::` 来建构符号 （比如：`QUAKE::HIDDEN-FUNCTION`）。 如果需要使用两个冒号来实际上线的代码， 那么一定有什么出错了，并需要人来修补。

有一个例外是， 单元测试可使用被测包的内部符号。 当你重构时，小心那些被包的单元测试所使用的内部符号。

`::` 用来建构非常临时的窍门 (hack)， 或是在 REPL 使用也是很有用的。 但若是符号真是外部可见的包定义中的一部分， 导出它。

你可能发现某些内部符号所代表的概念，你通常会想要抽象起来， 藏在表面之下，但有时又需要让外部扩展的人使用。 针对前一个理由，你不想导出它们， 针对后一个理由，你需要导出他们。 解决办法是有两个不同的包， 一个给正常用户使用，另一个给实现本身及扩展者使用。

包有两种：

*  一种是被纳入其它包的 `:use` 规格说明。 如果甲包使用乙包，则乙包的外部符号可以在甲包内被引用， 而无需使用包的前缀。 我们主要在底层模组使用这种包，来提供广用的实用函数。
 *  一种是不打算被使用。 要引用乙包提供的一个实用函数时， 甲包的代码必须使用一个显式的包前缀， 比如 `乙:DO-THIS`。

如果你添加了一个新的包，它应该总是第二种的， 除非你有一个特殊理由并获得许可。 包内的函数名会根据包的用途变化。 举例来说，如果你有一个叫做 `FIFO` 的抽象， 且是属于第一种类的包。 则你会有像是 `FIFO-ADD-TO` 以及 `FIFO-CLEAR-ALL` 这样名称的函数名。 如果你的包是第二种类的用途， 则会有像是 `FIFO:ADD-TO` 以及 `FIFO:CLEAR-ALL` 这样名称的函数名，因为调用者会 `FIFO:ADD-TO` and `FIFO:CLEAR-ALL` 这么用。 （`FIFO:FIFO-CLEAR-ALL` 既冗赘又丑陋。）

另一件关于包的好事是， 符号名不会与其它包的名称起冲突， 除非你的包"自己"起冲突。 所以你得小心 Lisp 实现自带的名称（因为你总是会用）， 以及其它你所使用的包的名称。 但你可以自由取任何名字，即便是短的名字， 而不需要担心别人使用了同样的名称。 包使你与别人隔离开了。

你的包绝对不要遮蔽(重定义）属于 Common Lisp 语言部分的符号。 某些时候例外，但理由必须要非常充分，这种情况相当稀少：

*  如果你显式地用一个更安全或更有特色的版本， 替换 Common Lisp 内置的符号。
 *  如果你定义一个不打算给人用的包， 并有一个好的理由，支持你导出与 Common Lisp 抵触的符号， 如 `log:error` 以及 `log:warn` 等等。

## 语言使用准则 ##

### 以函数式风格为主 ###

[link][link 29] ▽

不是必要的情况下，避免使用副作用。

Lisp 的最佳用法是"以函数式风格为主"。

避免改动局部变量，重新绑定试试。

避免创建对象并给他们的槽赋值。 最好在初始化的时候将槽设置好。

让类别越坚固越好，也就是说，尽可能避免给槽用赋值函数。

以函数是风格为主使得撰写线程安全的并发代码变得非常简单。 也使得测试代码变容易了。

### 递归 ###

[link][link 30] ▽

你应该偏好迭代胜于递归。

Common Lisp 系统不要求每个实现实作不会泄漏栈内存的尾递归 ── 也称为正规尾调用 (PTC)、尾调用消除(TCE) 或尾调用优化 (TCO)。 这表示由尾调用所产生的无穷递归很快就把栈吃光光了， 阻碍了函数式编程。 最严格的实现（包括了 SBCL 与 CCL) 还是有实作正规尾调用， 但有如下限制：

*  `(DECLARE (OPTIMIZE ...))` 的设置必须 `SPEED` 够高且 `DEBUG` 不能太高， 这里的够高与不能太高，每个编译器的数值都不同。 （举例来说，在 SBCL， 你应该避免 `(SPEED 0)` 以及 `(DEBUG 3)` 来实现正规尾调用。）
 *  应该避免在调用时使用动态绑定（即使某些 Scheme 编译器能够 正确处理这样的动态绑定，根据 Scheme 的说法是叫做 parameters。）

为了兼容所有的编译器及优化设置，以及避免调试时栈溢出发生， 你应该偏好迭代或是内置的映射函数，胜于依赖正规尾调用。

如果你真的得用正规尾调用的话， 你必须明显记录起来，并实验编译器的优化参数， 确保你使用了正确的优化设置。 想要有可移植到任何地方的代码， 你可以使用一个迭代地调用续延传递函数的循环 ([trampolines][])。

### 特殊变量 ###

[link][link 31] ▽

节制使用特殊变量。

应该节制使用 Lisp 的"特殊" （动态绑定）变量作为函数的隐式参数， 并且只在不会吓到读代码的人的前提下使用， 以及有显着好处的情况下使用。

每个特殊变量会建立状态。 当试着要了解代码在干嘛或代码怎么实现的时候， 开发者需要绞尽脑汁地追踪所有相关变量的状态； 需要撰写测试并运行所有相关的可能性； 要将某个行为隔离时，必须考虑到所有相关的局部变量， 包括那些没有直接使用模组的局部变量。 他们可能隐藏了珍贵的信息，可以通过印出回溯来得知。 特殊变量不仅给每个新创建的变量带来负担， 特殊变量数目上升时，也使变量之间的互动变得更复杂。 收支必须平衡啊。

需要注意的是，虽然 Lisp 的特殊变量， 与 BASIC 或 C 概念上的全局变量不同。 特殊变量可以动态地绑定到一个局部值， 在每个用户需要互相往来时， 比一般仅存放全局数值的内存空间（全局变量）来得强大。

特殊变量好的使用时机是， 当 “the current” 可以很自然的用作前缀时， 像是 “the current database connection” 或是 “the current business data source” 。 在其它代码仍有用到特殊变量的情况下，特殊变量是单例， 并通常作为显式参数传递， 但不对充满疑惑的源代码提高可读性或是可维护性。

特殊变量可以使撰写出能够重构的代码更简单。 如果你有一个处理请求链，有着数个操作在"当前"请求的层级， 将请求对象显式地传给每个函数， 需要在链中的每个函数都有一个请求参数。 将代码重构成新的函数，通常需要这些函数也有这个参数， 也会把用模版写成的代码弄的杂乱不堪。

应该将特殊变量想成是每个线程只有一个的变量。 默认情况下，你应该让一个特殊变量不具有任何的顶层绑定， 而每个需要用到特殊变量的线程控制，应该要显式地绑定。 这代表着任何误用特殊变量的情况， 会引起一个 “unbound variable” 错误， 而每个线程只会看到变量自己的值。 有默认全局数值的变量通常是在线程创建时绑定。 你应该使用适合的架构来自动妥善地宣告这样的变量。

### 赋值 ###

[link][link 32] ▽

使用赋值形式要一致。

有很多种风格来处理宏与副作用； 无论是使用那种包，保持使用一致的风格。 当开始写一个新包时，选择一个最有理的风格。

关于同一个形式里的多重赋值，有两种学派： 第一种学派认为仅可能将赋值都放在一个 `SETF` 或 `PSETF` 形式里， 这样可以将带有副作用的形式减到最少； 第二种学派认为将赋值尽可能分成单一的 `SETF` （或 `SETQ`，参见下面） 形式， 这样可以将有改动位置的形式定位， 使得 grep 寻找 `(setf (foo ...` 找到的机率上升到最高。 一个 grep 模式必须包含所有你在程序中可能有改动到位置的形式， 这样是具有说服力或是毫无意义的，取决于其馀代码的风格。 应该遵循你正在使用的包，里面所使用的惯例。 针对新的包来说，我们推荐第一种。

关于 `SETF` 以及 `SETQ`， 有两种学派： 第一种学派认为 `SETQ` 是前人遗留的实现细节， 尽量避免使用它，偏好使用 `SETF`； 第二种学派认为 `SETF` 加了一层额外的复杂度， 尽量避免使用它，尽可能使用 `SETQ` （也就是说，每当一个被赋值的位置是变量或 symbol-macro 时）。 应当遵守你正使用的包里的惯例。 针对新的包来说，我们推荐第一种。

以函数式风格为主的主要精神是， 让测试与维护变得更简单， 我们邀请你想想如何用最少的赋值来完成事情。

### 断言与条件式 ###

[link][link 33] ▽

你必须正确地使用断言与条件式。

*  `ASSERT` 应该只在侦测内部错误时使用。 程序应该 `ASSERT` 那些不变的值， 一旦 `ASSERT` 失败就表示软件哪里坏掉了。 不正确的输入应该在运行期妥善地处理， 并绝对不要产生违反断言的状况。 观赏断言失败的观众是开发者。 不要在 `ASSERT` 里使用 data-form 以及 argument-form 来指定要捕捉什么条件。 出于调试的目的，使用他们来印出信息没问题的 （而这仅用来调试，不会有国际化的问题）。
 *  `CHECK-TYPE`, `ETYPECASE` 也是断言的形式。 当某一个失败时，就找到了一个错误。 针对函数的输入， 应该偏好使用 `CHECK-TYPE` 胜于 `(DECLARE (TYPE ...))`。
 *  代码应该要可以自由地使用断言及类型检查。 及早发现错误，及早修补！ 只有在性能非常要求的地方，还有内部的辅助函数， 应该避开显式的断言及类型检查。
 *  不合法的输入，像是读取的文件与预期格式不符， 不应视为违反断言。总是检查输入，确保是合法的， 并在不合法的情况下，用适当的行动回应， 像是捕捉一个实际错误。
 *  `ERROR` 应用来侦测用户数据、请求、许可的问题等， 或是回报不寻常的输出给调用者。
 *  `ERROR` 应该始终被一个显式的条件类型调用； 应当永远不要仅用一个字串来调用。 这样才可能国际化。
 *  通过捕捉状况，回报不寻常输出的函数，应当在合约里明显说明； 当函数捕捉了一个状况，而状况不是在合约规范里时， 这是一个错误。 合约应清楚说明有状况类别。 函数则可以捕捉任何与那些状况同类的状况。 也就是说，记录在合约中类别的子类， 捕捉这些子类的实例是没问题的。
 *  复杂的错误检查可能需要使用 `ERROR` 而不是 `ASSERT`。
 *  在撰写一个服务器时，绝对不要调用 `WARN`。 而是应该使用合适的记录框架。
 *  代码绝对不要调用 `SIGNAL`。 而是使用 `ERROR` 或 `ASSERT`.
 *  代码不应该使用 `THROW` 以及 `CATCH`； 而是使用 `restart` 工具。
 *  代码不应该全盘处理所有的状况， 比如说，类别 `T` ，或是使用 `IGNORE-ERRORS`。 而是让未知的状况交给万能救星 Lisp 来处理。
 *  有少数场合，处理所有的状况是可以的，但这情况很少。 问题在于处理所有的状况，可能隐蔽了程序的错误。 如果你真的需要处理"所有的状况"， 你必须只处理 `ERROR`，绝对不要处理 `T` 以及绝对不要处理 `SERIOUS-CONDITION`。 （这是需要注意的，因为在 CCL 里，进程会不会终止， 取决于有没有捕捉到 `process-reset`， 并会交由 CCL 的处理器来处理，所以我们绝对不要插手。）
 *  `(error (make-condition 'foo-error ...))` 等价于 `(error 'foo-error ...)` ── 代码必须使用简洁的形式。
 *  在清除形式的 `UNWIND-PROTECT` 里，不应该捕捉状况 （除非他们总是在这形式里处理）。 不然就从清除形式跳出， 比如 `INVOKE-RESTART`。
 *  不要通过重新捕捉来结束一个状况。 如果你这么干，而刚刚的状况没有处理， 则栈的追踪会停在重新捕捉那点， 将之前的隐藏起来。 而隐藏起来的那部分，才是我们所关心的！
    
        ;; 差劲
        (handler-case
          (catch 'ticket-at
            (etd-process-blocks))
          (error (c)
            (reset-parser-values)
              (error c)))
    
        ;; 较佳
        (unwind-protect
          (catch 'ticket-at
            (etd-process-blocks))
          (reset-parser-values))

### 类型检查 ###

[link][link 34] ▽

如果你知道某个东西的类型， 为了要启用合理的编译期与运行期检查，你应该明确指明它的类型。

如果你的函数正使用特殊变量作为隐式参数， 帮特殊变量放一个 `CHECK-TYPE` 是很好的， 这有两个理由： 第一，给阅读代码的人留下线索，这个变量是隐式地作为参数； 第二，帮助找到错误。

使用 `(declare (type ...))` 是万不得已的手段，Scott McKay 如是说：

> 事实上，`(declare (type ...))` 根据编译器速度、 安全性、等等设定的不同，做出不一样的事情。 在某些编译器，速度比安全重要时，`(declare (type ...))` 会告诉编译器"请假设变量是这些类型"而不做任何类型检查。 也就是说，如果某个变量的值是 `1432`， 而你却说它的类型是 `string`， 编译器听信于你，并将它当成一个字串来使用。
> 
> 道德底线：不要使用 `(declare (type ...))` 来声明任何 API 函数的合约，这样做是不对的。 当然在“辅助函数”可以使用，但不是 API 函数。

当然你应该在内部底层函数里，使用适当的声明。 这些声明被用来优化代码。当你这么做的时候， 看看我们关于[危险操作][Link 5]的建议。

### Common Lisp 对象系统 ###

[link][link 35] ▽

适当地使用 CLOS。

当一个通用函数打算被其它模组调用时（其它部分的代码）， 应该要有一个显式的 `DEFGENERIC` 形式， 以及一个 `:DOCUMENTATION` 字串解釋函數的通用合約 （與某些特定類別解釋行為相反）。 一般寫显式的`DEFGENERIC` 形式是好的， 但在模組进入点來說是必须要写的。

当通用函数的参数列表包含了 `&KEY` 时， `DEFGENERIC` 应总是将所有可接受的关键字参数列出来， 并解释它们各代表着什么。 （Common Lisp 没有要求这么做， 但从可以避免 SBCL 产生不实的警告来说，这么做是好的。）

你应该避免使用 `SLOT-VALUE` 以及 `WITH-SLOTS`， 除非你完全想要回避，任何种类的方法结合对槽带来的影响。 稀少的例外包括了 `INITIALIZE-INSTANCE` 以及 `PRINT-OBJECT` 方法， 还有访问隐藏在底层里，提供用户可视抽象的实现方法。 不然你应该使用 `WITH-ACCESSORS` 访问器。

访问器的名称一般遵循 `<protocol-name>-<slot-name>` 的惯例， 其中“协议”在这个情况下，松散地指出了一组行为定义良好的函数。

是需要把正式的“协议”概念设计成不可实作， 就像第一类“协议”的对象没有实作那样。 但也可以是一个抽象 CLOS 类，或是一个嵌入协议的 [Interface-Passing Style][] 介面。 之后的（子）类或（子）介面，则可以通过给协议中的（通用）函数， 定义某些方法来实现协议部分或全部内容，包含了读取器及写入器。

举例来说，如果有一个象徵性的协议称为 `pnr` ，有着访问器： `pnr-segments`、`pnr-passengers` 以及 `pnr-passengers` ，则 `air-pnr`、`hotel-pnr` 及 `car-pnr` 类别只能给`pnr-segments` 及 `pnr-passengers` 合理地实作方法， 来作为访问器。

默认行为下，抽象基类名称拿来作为象徵性的协议名， 所以访问器名称默认是 `<class-name>-<slot-name>`； 当这些名称常常使用时， 就不再偏好或需要用这个形式。 一般来说呢，这使得符号名"更长了"， 而且在许多情况里，会导致 "trampoline" 方法散布开来。

不应该使用由 `<slot-name>-of` 命名的访问器。

显式的 `DEFGENERIC` 形式应在通用方法 （或是将来可能）超过一个以上的 `DEFMETHOD` 情况使用。 这个理由是通用函数的文档解释函数的抽象合约， 而不是解释每个方法给哪些具体的类别做什么。

再没有一个象徵性协议时，绝对不要使用通用函数。 更具体来说，如果你有超过一个通用函数，且特化 N 个参数， 所有正特化的类别，全部都应当是一个单类的子孙。 通用函数绝对不要用来实现"重载"，也就是说， 只在拿来表示两个完全无关的类别的情况下使用。

更精确的说，并不是他们需要从一个常见的超类演化而来， 而是他们需要遵守同样的“协议”。 也就是两个类别应处理同一组通用函数， 就像是每个方法都有一个显式的 `DEFGENERIC` 存在一样。

以下是另一种说法。 假设你有两个类别，甲跟乙，以及一个通用函数丁。 丁有两个方法，分别派发类型甲与乙的参数。 也许在程序的某个地方，有个函数调用了丁， 而传入的参数可能在运行期时， 属于类别甲，而某些时候属于类别乙，这样是合理的吗？ 如果不合理的话，你可能正在使用重载，而且你不应使用单个通用函数。

这个规则有一个例外： 如果相应的参数代表同样事情时，用重载是没问题的。 通常一个重载会接受一个 X 对象， 以及其他接受 X 对象名称的对象， 可能是符号或是别的。

绝对不要在运行期使用 [MOP][] 的“调停”操作。 在编译期你也不应该使用 MOP 的"调停"操作。 在运行期时，MOP 的调停操作， 在最坏的情况下是个危险，最好的情况下是个效能问题。 在编译期时，宏应在第一轮就把事情办到定位， 而不是需要第二轮透过调停操作来事后修补； 但某些时候，修补是解决向前引用的必要手段， 且此时调停操作是允许的。 MOP 的调停对于互动式开发来说是一个极好的工具， 且你可以在开发及调试的过程中享受它的美妙； 但你不应当在一般应用里使用。

如果类定义创建了一个作为 `:READER`、`:WRITER`, 或是 `:ACCESSOR` 的方法，不要重定义该方法。 加入 `:BEFORE`、`:AFTER` 以及 `:AROUND` 这些辅助方法是可以的， 但不要重写主要方法。

在有关键字参数的方法里， 你必须永远使用 `&KEY`， 即便是方法不在乎键的值是什么， 你也永远不应该使用 `&ALLOW-OTHER-KEYS`。 只要关键字被任何通用函数的方法所接受时， 在通用函数里使用它是 OK 的， 即使同样的通用函数没有特别提到它。 这对于 `INITIALIZE-INSTANCE` 方法来说特别重要， 若是你使用了 `&ALLOW-OTHER-KEYS`， 这会把调用 `MAKE-INSTANCE` 时， 检查拼错或是错误关键字的错误禁能！

一个典型的 `PRINT-OBJECT` 方法看起来可能像是这样：

(defmethod print-object ((p person) stream)
      (print-unprintable-object (p stream :type t :identity t)
        (with-slots (first-name last-name) p
          (safe-format stream "~a ~a" first-name last-name))))

## 元语言准则 ##

### 宏 ###

[link][link 36] ▽

在适当的时机使用宏，这种情况很常见。 在适当的时机定义宏，这种情况很少见。

宏带来了语法上的抽象，是个美妙的东西。 通过表明你想干什么，使你的代码更清晰， 同时不被实现细节给绑手绑脚 （将那些细节抽象起来）。 通过消除那些冗赘及无关的细节。 使你的代码更简洁、可读性更高， 但鱼与熊掌不可兼得， 读者需要学习每个宏所带来的新语法概念。 而宏不应该滥用。

普遍的结论是在好的 Common Lisp 程序里， 不应该认出任何的*设计模式*。 唯一且只有一个的模式是：*使用语言本身*， 包含了定义及使用语法上的抽象。

每当宏可以使代码变清晰时，必须使用现有的宏， 通过将目的用更简洁的方式传达，这是很常见的。 当你的项目里有可用的宏，来表达你正使用的概念， 你必须使用宏，而不是写出概念的展开式。

新的宏应当在恰当时机下定义（很少）。 针对常见的宏，几乎已经由语言及多样的函式库所提供了， 根据你的程序大小，通常只会需要用到少数几个新的宏。

你应该遵循 [OAOOM][] 经验法则（不超过两次）来定义一个新的抽象， 无论是否是语法的抽象： 如果特定的模式使用超过两次，那么应该将它抽象起来。 一个更精确决定何时使用抽象的规则是， 应该考虑到使用次数及每次使用的增益， 与阅读代码时需要习惯的时间成本来比较， 通常阅读代码需要习惯的时间成本较为重要， 因为好的代码通常仅写一次，会被许多人阅读许多次 （维护该程序的程序员，忘记代码之后也会重读）。 然而撰写宏所要花费的成本也要考虑进去； 但这么一来应当比较的是，程序员撰写可能有更高收益的代码的成本。

正确使用 Lisp 宏需要品味。 避免写复杂的宏，除非利明显大于弊。 宏使与你协作的开发者需要费劲来学你的宏， 所以你应该在只有获得的表达性超过了成本时，才使用宏。 和往常一样，当你不确定时，尽管找你的同事谘询， 由于没有大量的 Lisp 经验， 是很难来判断究竟该不该用宏。

绝对不要在函数可以办到的情况下使用宏。 也就是说，如果你正在写的东西的语义， 与一个函数的语义相符，那么你必须用函数写成，而不是宏。

绝对不要为了性能的原因，将一个函数转成一个宏。 如果评测器显示一个特定函数 `FOO` 有性能问题时， 将需求及评测结果适当地记录下来，并将 `FOO` 声明为内联： `(declaim (inline foo))`。

你也可以使用一个编译宏作为加速函数执行的手段， 通过指定一个来源到来源的转换。 注意这会干扰到追踪与优化函数。

当你写一个由宏定义的宏时（一个产生宏的宏）， 要特别清楚地注解、记录起来， 因为这种宏对于任何人来说都是很难理解的。

绝对不要在没有与开发系统的其他开发者，取得共识的情况下设置新的读取宏。 读取宏绝对不可以泄漏系统的信息，不论是泄漏给正使用读取宏的系统的客户， 或是泄漏给项目里的其它系统。 你必须使用如 `cl-syntax` 或 `named-readtables` 的软件，来控制读取宏是如何被使用的。 想要有一样读取宏的用户，可以使用和你一样的读取宏。 无论如何，你的系統必須在有或沒有使用讀取宏的情况下，都一样那么好用。

如果你的宏有一个参数，是一个 Lisp 形式，会在展开代码时被求值， 你应该将此参数用 `-form` 字尾命名。 这个惯例让使用宏的使用者更清楚哪些是会被求值的 Lisp 表达式， 而那些不是。 常见名称如 `body` 以及 `end` 是这个规则的例外。

当情况适用时，你应该仿效使用所谓的 `CALL-WITH` 风格。 这个风格在 [http://random-state.net/log/3390120648.html][http_random-state.net_log_3390120648.html] 详细地解释了。 一般的原则是，宏被严格地限制在仅处理语法，而语义尽可能交由一般的函数处理。 因此，一个 `WITH-FOO` 宏通常被限制在， 用来产生一个对辅助函数 `CALL-WITH-FOO` 的调用， 其中参数由宏参数推导而来。 宏的 `&body` 参数通常包在一个会成为主体的 lambda 表达式， 作为传给辅助函数的一个参数之一。

语法与语义分离是个基本的风格法则，远超出 `WITH-` 宏所讨论的情况。 它的好处多多。 通过将语义隔离在宏之外，宏将变得更简单，更容易写对，并更少受到变化影响， 也使得开发与维护更容易。 用一个更简单语言 ── 无需分阶段的语言 ── 写成的语义， 使得维护与开发更容易。 无需重新编译所有使用宏的代码，就可以调试与更新语义函数也变得可能了。 出现在栈追踪的语义函数，同时帮助了调试使用了宏的函数。 宏的展开式更简短了，而每个展开式与其它展开式共享了更多代码， 这简少了每个展开式占用的内存，通常使执行变得更快。 先写语义函数是有道理的，然后在这之上写一个作为语法糖的宏。 应该使用这个风格，除非宏是用在考量到性能的循环； 既便是如此，看看关于优化的规则。

任何由宏创建的函数（闭包）应该要取名字， 这可以通过使用 `FLET` 来完成。 这也允许你声明一个有动态范围的函数（如果是的话 ── 往往便是 ── 请见下文关于[动态范围][Link 6]的内容）

如果一个宏调用包含了一个形式， 且宏展开式包含了不只一个该形式的复本， 形式可能被求值一次以上，则将其码成包含宏展开的形式， 并编译一次以上。 如果某人使用了这个宏，使用具有副作用或需要计算很久的形式，来调用这个宏， 这样的行为是不招人待见的（除非你有意要写一个像是 loop 的控制结构）。 一个避免这个问题的便捷方式是，仅对形式求值一次， 并将结果绑订制一个（产生的）变量。 有一个非常有用的宏，叫做 `ALEXANDRIA:ONCE-ONLY` ，产生会办到此事的代码。 同时看看 `ALEXANDRIA:WITH-GENSYMS` 是如何在产生的代码里， 创建某些暂时的变量。注意，如果你遵循我们的 `CALL-WITH` 风格， 你通常只展开代码一次，要嘛作为传给辅助函数的参数， 或是作为一个作为参数所传入的 lambda 表达式的主体； 因此你避开了上面所谈到的复杂性。

当你写一个有主体的宏时，比如一个 `WITH-xxx` 宏， 即使没有任何参数，你应该为他们预留位置。 不要让调用看起来像是 `(defmacro with-lights-on (&body b) ...)`， 而是`(defmacro with-lights-on (() &body b) ...)`。 这么一来，如果在未来需要参数时，你可以添加它们， 而无需改变所有用到宏的代码。

### 何时求值 ###

[link][link 37] ▽

当使用 `EVAL-WHEN` 时，你应该总是使用所有的 `(:compile-toplevel :load-toplevel :execute)`.

Lisp 求值过程发生在很多时期，某些时期是相互交错的。 当撰写宏时，意识到这些时期。 [EVAL-WHEN 被认为对你的健康是有害的][EVAL-WHEN]。

总结上面那篇文章所述， 除非你正使用非常先进的宏术(macrology)， 不然在一个 `EVAL-WHEN` 唯一合法的组合是， 纳入所有的 `(eval-when (:compile-toplevel :load-toplevel :execute) ...)`。

每当你定义将会用在宏的，函数、类型、类别、常量、变量等，必须使用 `(eval-when (:compile-toplevel :load-toplevel :execute) ...)`。

忽略 `:execute` 通常是一个错误，因为它预防了加载源码，而不是 fasl 文件。 忽略 `:load-toplevel` 通常是一个错误 （除了改动 readtables 及 编译期设置之外），因为它预防了加载未来的文件，或是 互动地编译代码，此代码依赖在编译期产生的效果，除非当前文件是 `COMPILE-FILE` 在同个 Lisp 会话被编译的。

关于变量，注意宏可能也可能不会，在运行展开后代码的同一个进程里被展开， 绝对不要依赖编译期间及运行期的效果，因为它们在其他时间可能是可视， 也可能是不可视的。 但在宏仍有几个合法的变量用途：

*  某些变量可能保有某种新定义或元数据的字典。 如果元数据在运行期（且/或其他文件里）视可视的，必须确定宏展开的代码， 在加载期间会将定义注册到这些元数据结构里。 除了在编译期会影响注册之外，通常顶层定义会展开成实现注册的代码。 如果代码没有在顶层展开，你可以使用 `LOAD-TIME-VALUE` 来获得好的效果。 在极端情况下，你可能需要使用`ASDF-FINALIZERS:EVAL-AT-TOPLEVEL`。
 *  某些变量可能保有暂时性的数据，这些数据只在文件的编译期使用， 并可以在文件编译完后清理掉。 预先定义这样的变量会包含 `*readtable*` 或 编译器内部的变量，有着当前的优化设置。 你可以常常将现有的及这种新的变量合并，使用 `ASDF` 的 hook 函数: `:AROUND-COMPILE`。

### 读取期求值 ###

[link][link 38] ▽

你应该节制地使用 `#.` 并必须避免读取期的副作用。

标准的 `#.` 读取宏，会读入一个对象， 给对象求值，而读取器会返回结果的值。

绝对不要在有常见解决方式时，还使用读取宏，常见解决方式： 像是 `EVAL-WHEN` 在编译期对副作用求值， 使用一个普通的宏来返回在编译期计算的表达式， 使用 `LOAD-TIME-VALUE`在加载期计算它。

读取期计算通常是一个让某物在编译期被求值的快速方式 （通常是“读取”期，但这两者是一样的）。 如果你使用这个，求值过程绝对不要有任何副作用， 并绝对不可以依赖任何变量的全局状态。 `#.` 应被视为一种强迫“常量摺叠”的方式， 够聪明的编译器会自己想出解决办法，当编译器不够聪明时， 差异就体现出来了。

另一个 `#.` 的用途是在该位置展开宏的等价，等价不是表达式， 也不是（准）引用，而是像 lambda 列表。然而若你发现自己 lambda 列表用的很多， 是时候想想，是不是该定义宏来取代 lambda 列表。

每当你要使用 `#.` 的时候， 你应该考虑使用 `DEFCONSTANT` 以及它的变种， 大概在一个 `EVAL-WHEN` 来给值一个名字， 解释它代表着什么。

### 求值 ###

[link][link 39] ▽

绝对不要在运行期使用 `EVAL`。

真正适合用 `EVAL` 的地方很少， 且必须与审查者商量的情况很久才发生一次； 很容易被滥用。

如果你的代码在运行期时操作符号， 并需要获取符号的值， 使用 `SYMBOL-VALUE` 而不是 `EVAL`。

通常实际上你需要的是写一个宏， 而不是使用 `EVAL`。

你可能会试着要用一种语言中安全的子集， `EVAL` 来作为求值表达式的捷径。 但这样用 `EVAL`，通常需要比建构一个特殊用途的求值器， 还要更详细地检查所有的输入。

`EVAL` 可运用的场合有：

*  用以实现交互的开发工具。
 *  建构基础设施
 *  测试框架的后门程序。 (绝对不要在上线的代码里，有这样的后门程序)
 *  编译期摺叠常量的宏。
 *  将定义注册到元数据结构的宏； 注册形式有时在编译期求值，宏展开式也是， 所以马上就可给其它宏所用。

注意在后面的情况里，如果宏不是要在顶层所使用， 那么可能无法使这些定义可用于展开式的一部分。 同样的情形可能发生在 `DEFTYPE` 展开式里，或发生在宏所使用的帮助函数。 在这些情况里，实际上你可能需要在宏里使用 `ASDF-FINALIZERS:EVAL-AT-TOPLEVEL`。 这不仅会在宏展开期 `EVAL` 你的定义，使定义立即可用， 同时也会保留这个形式，加入到 `(ASDF-FINALIZERS:FINAL-FORMS)`， 此时你必须在文件编译结束时，将其纳入（或在需要用到形式前）。 这么一来，加载 fasl 文件的副作用就体现出来了，而无需在编译前先行编译； 在这两个情况里，形式在加载期都是可用的。 如果你忽略的话，通过抛出一个错误， `ASDF-FINALIZERS` 确保形式是存在的。

### 导入与导出 ###

[link][link 40] ▽

绝对不要在运行期使用 `INTERN` 或 `UNINTERN`。

绝对不要在运行期使用 `INTERN`。 导入不仅会构造，也创建了一个不会被蒐集的持久符号，或给予访问内部符号的权限。 这给内存泄漏、服务攻击拒绝、未授权的内部访问、符号冲突等，打开了大门。

绝对不要为了比较关键字，而导入一个字串； 使用 `STRING=` 或 `STRING-EQUAL`。

(member (intern str :keyword) $keys) ; 差劲

(member str $keys :test #'string-equal) ; 较佳

绝对不要在运行期使用 `UNINTERN`。 这可能会损坏依赖动态绑定的代码。 使得代码更难调试。 绝对不要动态地导入任何新符号， 因此你也不需要动态地导出任何东西。

当然可以用某些宏的实现，在编译期使用 `INTERN`， 即使是如此，通常更适当的是基于宏之上抽象起来，如： `ALEXANDRIA:SYMBOLICATE` 或 `ALEXANDRIA:FORMAT-SYMBOL` 来创建你需要的符号。

## 表示数据 ##

### NIL: 空表、假、以及我不知道 ###

[link][link 41] ▽

适当地使用或避免使用 NIL。

`NIL` 可以有几个不同的解读：

*  “逻辑假” 在这个情况里，使用 `NIL`。 你应该使用操作符 `NOT` 或判断式函数 `NULL` 来检验逻辑假。
 *  “空列表” 在这个情况里，使用 `'()`。 （当调用宏的时候，要小心引用空表。） 当参数已知是正规列表时， 你应该使用 `ENDP` 来检验是否为空列表， 或者使用 `NULL`。
 *  一个关于某个不确定值的陈述句。 在这个情况里，如果代码歧义不会带来任何危险的话， 你可以使用 `NIL`； 不然你应该使用一个明确的、具描述性的符号。
 *  一个关于某个已知不存在的值的陈述句。 在这个情况里，你应该使用一个明确的、具描述性的符号，而不是 `NIL`。

绝对不要在数据表示法里引入歧义，这会让无论是谁需要来调试代码的人偏头痛。 如果有任何歧义的危险存在， 你应该使用一个明确的、具描述性的符号或关键字，举个例子， 用使用`NIL` 来代表同样的两件事。 如果你真的使用了 `NIL`， 必须确定之间的差异有完整的在文档里说明。

在许多语境里， 与其将“我不知道”作为一个特定值， 不如使用多个数值， 一个给已知的数值（有的话）， 而另一个表示数值是否已知或找到。

在用数据库类别时，记住 `NIL` 不需要总是映射到 `'NULL'` （反之亦然）！ 数据库的需求可能与 Lisp 的需求不太一样。

### 别滥用列表 ###

[link][link 42] ▽

必须正确选择数据的表示法。 绝对不要滥用 `LIST` 数据结构。

虽然在 1958 年，LISP 是“列表处理, LISt Processing”的简称， 但 Common Lisp 的后继者，从 80 年代起， 已经转变成为现代的程序语言，有着现代的数据结构。 必须在程序里使用正确的数据结构。

绝对不要在不适用的场合，滥用内置的（单链结的）`LIST` 数据结构， 即使 Common Lisp 让列表变得如此简单易用。

绝对不要使用列表，当手边算法有符合此性能特点时： 循序的对列表的所有内容做迭代。

可以这么使用列表的例外是，当预先知道列表长度会是很短的时候 （少于 16 个元素）。

列表数据结构通常（但不总是）适合让宏与被宏使用的函数在编译期使用： Common Lisp 源代码用列表传递，但宏展开式及编译过程通常会 将源代码整个循序地过一遍。（切记先进的宏系统不直接使用列表， 而是使用抽象的语法对象，来追踪源代码的位置与作用域； 然而现今 Common Lisp 还没有如此先进的宏系统。）

另一个可以使用列表的例外是引入，会在编译期或加载期转成适当数据结构的字面常量。 有一个相对短的函数名，来从这样的常量建构程序的数据结构是很好的。

当列表不适合作为数据结构的许多情况下， 多样的函式库如： [cl-containers][] or [lisp-interface-library][] 提供了许多不同的数据结构，应该可满足你程序的所有基本需求。 如果现有的函式库满足不了你的话，看看上面关于 [使用函式库][Link 7] 以及 [开源代码][Link 8] 这两点。

### 列表 x 结构 x 多值 ###

[link][link 43] ▽

你应该使用恰当的表示法，来表示多个类型。

应该避免使用一个列表，作为存放相同类型的元素的容器。 绝对不要使用列表，作为在函数进出之间，传递不同类型的多重数值的手段。 某些时候使用列表当作临时的数据结构是很方便的，也就是说， “列表的第一个元素是 FOO，而第二个是 BAR”， 但这应该少用，因为要记得这小小的惯例得花大大的心力。 绝对只在，解构函数参数列表或创建参数列表给 `APPLY` 应用至函数， 这两个情况下使用列表。

正确的将由数种异质类型数值所组成的对象，传递的方法是， 使用一个用 `DEFSTRUCT` 或 `DEFCLASS` 定义的结构。

应该只在函数返回少量数值时，来使用多重数值， 其中这些少量数值会被调用者直接解构，而不会将其作为参数传给之后的函数。

应该不要返回一个状况对象，作为多重数值的一个值。 你应该捕捉状况来表示一个不寻常的输出。

你应该捕捉一个状况，来表示一个不寻常的输出， 而不是依赖特别的返回类型。

### 列表 x 点对 ###

[link][link 44] ▽

当操作列表时，使用恰当的函数。

使用 `FIRST` 来访问列表的第一个元素， `SECOND` 来访问第二个元素等。 使用 `REST` 来访问列表的尾端。 使用 `ENDP` 来检验是否是列表的底部。

当构元不是用来实现一个正规列表时， 使用 `CAR` 及 `CDR` 并 将其是为一对更通用的对象。 在这个上下文里，使用 `NULL` 来检验 `NIL`。

后者除了在 alist 之外很罕见，因为你应该在适当的场合使用结构与类别。 当你想要使用树的时候，使用数据结构的函式库。

当手动解构列表时，你可以例外地使用 `CDADR` 及其它列表的组合操作。 而不是使用一组列表访问函数。 在这个语境里，使用 `CAR` 及 `CDR`，而不是 `FIRST` 及 `REST` 也合情合理。 然而要记住的是，在这样的情况里， 用 `DESTRUCTURING-BIND` 或 `OPTIMA:MATCH` 可能更合适。

### 列表 x 数组 ###

[link][link 45] ▽

当随机访问很重要时，使用数组而不是列表。

`ELT` 在列表的时间复杂度为 *O(n)* 。 如果你想要随机访问一个对象的元素时， 用数组及 `AREF` 来取代。

有个例外是不是关键部分的代码可以使用， 还有已知列表的长度很短的情况。

### 列表 x 集合 ###

[link][link 46] ▽

你应该只在长度非常短的情况下，将列表作为集合使用。

使用列表来表示集合不是个好好点子，除非你知道列表的长度很短。 访问器的时间复杂度是 *O(n)*， 而不是原本的 *O(log n)*。 关于任意的大集合，使用平衡的二叉树， 比如使用 `lisp-interface-library`。

如果你仍坚持将列表作为集合使用， 不要只是为了搜寻而对列表调用 `UNION`。

(member foo (union list-1 list-2)) ; 差劲

(or (member foo list-1) (member foo list-2)) ; 较佳

`UNION` 不仅有无谓的构造， 在某些实现里，时间复杂度还可能达到 *O(n^2)*， 就算在 *O(n)* 的情况，相对来说也是很慢的。

## 适当形式 ##

你必须遵循函数、宏以及特殊形式的正确使用方式。

### 定义常量 ###

[link][link 47] ▽

你必须给常量值使用正确的定义形式。

我们主要用的 Lisp 系统，SBCL，非常挑剔，只要常量被重定义至一个 不 `EQL` 先前数值的新值时，会捕捉一个状况。 当定义不是数字、字符、或符号（包括布尔及关键字）的变量时， 绝对不要使用 `DEFCONSTANT`。 一致地使用不管你项目里所推荐的替代方案来取代。

;; 差劲
    (defconstant +google-url+ "http://www.google.com/")
    (defconstant +valid-colors+ '(red green blue))

开源函式库可能使用了 `ALEXANDRIA:DEFINE-CONSTANT` 来定义非数字、字符及符号（包括布尔与关键字）的常量。 你可以使用 `:TEST` 关键字参数来 指定一个相等性的判断式。

;; 较佳，给开源代码:
    (define-constant +google-url+ "http://www.google.com/" :test #'string=)
    (define-constant +valid-colors+ '(red green blue))

在优化像是 SBCL 或 CMUCL 的实现时要注意， 这么定义常量使得之后的重定义，不会 `UNINTERN` 符号， 并需要重新编译所有用到常量的代码。 这么做使得在 REPL 调试代码“更有趣了”，或可以即时布署代码更新。 如果“常量”在整个服务器进程生命周期，有可能会变成非常量时， 考虑到如期或不定期的代码补丁后，你应考虑使用 `DEFPARAMETER` 或 `DEFVAR` 来取代， 或是使用 `DEFINE-CONSTANT` 的变种， 建构于某些未来函式库之上，实现了全局词法而不是 `DEFCONSTANT`。 可以在这些情况中保留 `+plus+` 的惯例， 并记录参数作为常量的目的为何。

注意 `LOAD-TIME-VALUE` 可能可以帮助你避免掉 定义不必要的常量。

### 定义函数 ###

[link][link 48] ▽

你应该正确使用 `&OPTIONAL` 以及 `&KEY` 参数。 不要使用 `&AUX` 参数。

你应该避免使用 `&ALLOW-OTHER-KEYS`， 因为这使得函数的合约变得模糊不清。 几乎所有实际的函数（通用或不通用），都允许某组关键字， 对调用者来说，这些关键字用来作为契约的一部分。 如果你实现了通用函数的一个方法，且不需要知道某些关键字参数的值， 你应该明确的 `(DECLARE (IGNORE ...))`， 将所有你没有用到的参数忽略掉。 绝对不要使用`&ALLOW-OTHER-KEYS`， 除非你明确地想要在调用通用函数， 参数匹配这些特定方法的时候，禁止检查所有方法允许的关键字。 注意到通用函数的契约是属于 `DEFGENERIC`， 而不是`DEFMETHOD`，这对于通用函数的调用者来说， 基本上只是通用函数的实现细节。

一个适用 `&ALLOW-OTHER-KEYS` 的情况是， 当你为某些（在计算期或开发期间）可能会变的函数写包装器函数时， 并传入一个 plist 作为 `&REST` 参数。

应该避免使用 `&AUX` 参数，

应该避免同时使用 `&OPTIONAL` 以及 `&KEY` 参数， 除非指定关键字参数永远都没有意义，以及当选择性參數没有全都指定时。 当你的函数同时有 `&OPTIONAL` 以及 `&KEY` 参数时，绝对不要给 `&OPTIONAL` 参数 用一个非 `NIL` 的缺省值。

为了让函式库有最大的可移植性，`DEFMETHOD` 的定义 应用 `(DECLARE (IGNORABLE ...))` 忽略所有没用到的参数。 如果你忽略 `(DECLARE (IGNORE ...))` 那些参数， 某些实现会发出错误讯息，而其它实现会在你没有 `(DECLARE (IGNORE ...))` 发出错误讯息。 `(DECLARE (IGNORE ...))` 在所有的实现都可用。

应该避免在函数里过度的嵌套绑定。 如果函数有大量的嵌套，你应该将其分成数个函数或宏。 如果这真的得是一个概念单元， 考虑使用像是 `FARE-UTILS:NEST` 的宏， 至少可以减少缩排的数量。 在典型的短函数里（四层或更少层的嵌套）使用 `NEST` 是差劲的， 但不在特别长的函数（十层或更多层的嵌套）里使用也是差劲的。 运用你的判断力并请教你的审查者。

### 条件表达式 ###

[link][link 49] ▽

使用恰当的条件表达式。

使用 `WHEN` 及 `UNLESS`， 当只有一个可能性时。 当有两个可能性时，使用 `IF`； 两个以上可能性时，使用`COND`。

但不要在一个 `IF` 子句里使用 `PROGN` ── 使用 `COND`、`WHEN` 或 `UNLESS`。

注意在 Common Lisp 里， 当条件不符合时， `WHEN` 及 `UNLESS` 返回 `NIL`。 你可以利用这个特点。 尽管如此，如果你有一个具体的理由，坚持要返回什么值， 你可以使用一个 `IF`来明确的返回 `NIL`。 你也可以相同地在 `COND` 的最后一个子句加入 else 子句： `(t nil)`， 或 `(otherwise nil)` 作为 CASE 的最后一个情况，来强调条件式返回的值很重要，会在之后被使用。 当条件式用于副作用时，你应该避免使用 else 子句，

当 `AND` 及 `OR` 与 `IF`、`COND`、 `WHEN` 或 `UNLESS` 比起来，可以产生更简洁的代码并没有副作用时， 你应该偏好 `AND` 及 `OR`。 你也可使用一个 `ERROR` 作为 `OR` 最后一个子句的副作用。

应该只使用 `CASE` 以及 `ECASE` 来 比较数字、字符或符号（包括布尔与关键字）。 `CASE` 使用了 `EQL` 来比较， 所以字串、路径名以及结构不会如你想的那样比较，且 `1` 与 `1.0`是不同的。

应该使用 `ECASE` 以及 `ETYPECASE` 优先于 `CASE` 及 `TYPECASE`。 即早捕捉到错误是比较好的。

应该完全不要使用 `CCASE` 或 `CTYPECASE`。 至少，你应该不要在服务器进程里使用他们，除非你有一个健壮的错误处理的基础建设， 并确保不会因此泄漏出敏感数据。 `CCASE` 与`CTYPECASE` 的用途是交互使用， 如果数据或控制结构泄漏给攻击者时，可能会产生有趣的损害。

绝对不要在`CASE`里，使用没有目的的单引号。 以下是个常见错误：

(case x ; 差劲: 没有匹配时，静静地返回 NIL
      ('bar :bar) ; 差劲: 捕捉了引用
      ('baz :baz)) ; 差劲: 也会捕捉引用

(ecase x ; 较佳: 没有匹配时会回报错误
      ((bar) :bar) ; 较佳: 不会匹配引用
      ((baz) :baz)) ; 较佳: 理由同上

`'BAR` 等于 `(QUOTE BAR)`， 代表当 `X` 是 `QUOTE` 时， 接下来的表达式会被执行 (`:bar`)，并继续匹配第二个子句 （虽然 `QUOTE` 已经被第一个子句捕捉了）。 通常不是你想要的情形。

在 `CASE` 形式里， 必须使用 `otherwise`，而不是 `t`。 来表达“如果其它都匹配失败的话，执行这个”。 必须使用 `((t) ...)`， 来表达“匹配符号 T” 而不是“全部都会匹配”。 同时你必须使用 `((nil) ...)`， 来表达“匹配符号 NIL” 而不是“什么都没匹配”。

因此，如果你想将布尔值 `NIL` 及 `T` 分别映射到 符号 `:BAR` 及 `:QUUX` ，应该避免前面的方式， 而使用后面所解释的方式。

(ecase x ; 差劲: 没有实际的错误用例
      (nil :bar)) ; 差劲: 什么都没匹配
      (t :quux)) ; 差劲: 全部都会匹配

(ecase x ; 较佳: 会确实捕捉非布尔值
      ((nil) :bar)) ; 较佳: 匹配 NIL
      ((t) :quux)) ; 较佳: 匹配 T

### 同一性 x 相等性 x 比较 ###

[link][link 50] ▽

当比较对象时，你应该使用恰当的判断式。

Lisp 提供了四种通用的相等性判断式： `EQ`、`EQL`、`EQUAL` 以及 `EQUALP`, 语义上有着微妙的差别。 此外， Lisp 提供了具体类型的判断式： `=`、`CHAR=`、`CHAR-EQUAL`、`STRING=` 以及 `STRING-EQUAL`。 知道这些函数的区别！

应该使用 `EQL` 来比较对象及符号的*同一性*。

绝对不要使用 `EQ` 来比较数字或字符。 两个 `EQL` 的数字或字符，在 Common Lisp 里不需要是 `EQ` 的。

当在 `EQ` 及 `EQL` 之间做选择时， 应该使用 `EQL`，除非你正写一个关系性能的底层代码。 `EQL` 简化了一类尴尬错误发生的机会（也就是数字或字符完全没比较的错误）。 关于`EQ`，可能有一个微小的性能成本。 但在 SBCL 下，通常会将其整个编译。 `EQ` 等价于有类型声明的 `EQL` 。 使用 `EQ` 应视为用来作为优化手段的[危险操作][Link 5]。

应该使用 `CHAR=` 来比较大小写无关的字符， 而 `CHAR-EQUAL` 来比较大小写有关的字符。

应该使用 `STRING=` 来比较大小写有关的字串， 而 `STRING-EQUAL` 来比较大小写无关的字串。

一个使用 `SEARCH` 搜索字串的常见错误是提供 `STRING=` 或 `STRING-EQUAL` 作为 `:TEST` 函数。 `:TEST` 函数给定两种序列元素做比较。 如果序列是字串的话，则 `:TEST` 函数一次调用两个字符， 所以正确的测试是 `CHAR=` 或 `CHAR-EQUAL`。 如果你使用 `STRING=` 或 `STRING-EQUAL` ， 结果正如你预期的，但在某些 Lisp 实现里非常之慢。 举例来说，CCL (至少在 2008 年 8 月时)，在每次比较时，创建一个单字符的字串， 这代价是非常昂贵的。

还有，应该给 `STRING=` 或 `STRING-EQUAL` 使用 `:START` 及 `:END` 参数，而不是使用 `SUBSEQ`； 打个比方，应该使用 `(string-equal s1 s2 :start1 2 :end1 6)` 来取代`(string-equal (subseq s1 2 6) s2)`。 这是比较推荐的，因为它没有构造。

应该使用 `ZEROP`、`PLUSP` 或 `MINUSP`，而不是用一个 `0` 或 `0.0` 的值来比较。

绝对不要给浮点数使用一个确切的比较， 由于浮点运算的本质会产生小的数值计算误差。 你应该把绝对值与一个临界值比较。

必须使用 `=` 来比较数字， 除非你要比较的是不等于 `0`、`0.0` 及 `-0.0` 的情况，这个情况应使用 `EQL`。 再次说明，绝对不要使用给浮点数使用确切的比较。

货币数量应该使用十进制（有理数）的数字，来避免浮点运算的复杂度及舍入误差。 像是 [wu-decimal][] 的函式库可能可以帮上忙； 再一次强调，如果函式库不能满足你的需求，看看上面关于 [使用函式库][Link 7] 以及 [开源代码][Link 8] 的说明。

### 迭代 ###

[link][link 51] ▽

给迭代使用恰当的形式。

你应该使用简单的形式，像是 `DOLIST` 或 `DOTIMES`， 而不是使用 `LOOP` 简单的形式像是当你不需要使用 `LOOP`的工具，如绑定、蒐集、块返回时，这些简单的情况。

当可以避免 `LET` 嵌套时， 使用 `LOOP` 的 `WITH` 子句。 在代码会变得更清晰的情况下，你可以使用 `LET`， 来返回 `LOOP` 使用后所绑定的变量， 而不是使用一个笨拙的 `FINALLY (RETURN ...)` 形式。

在 `DOTIMES` 的主体中，不要设置迭代变量。 (若你这么做的话，CCL 会发出一个编译器警告。)

多数系统在当前包使用未修饰的符号来做为 `LOOP` 的关键字。 其他系统使用从 `KEYWORD`包而来的，实际关键字 `:keywords`，作为 `LOOP` 的关键字。 你必须与系统里所使用的惯例保持一致。

### 输入与输出 ###

[link][link 52] ▽

使用恰当的输入与输出函数。

当撰写一个服务器时，代码绝对不要将输出送至像是 `*STANDARD-OUTPUT*` 或 `*ERROR-OUTPUT*` 的标准流。 代码必须使用正确的记录框架，给调试输出信息。 我们是运行一个服务器，所以没有控制台！

代码绝对不要使用 `PRINT-OBJECT` 来与用户沟通 ── `PRINT-OBJECT` 是只拿来做调试的。 改动任何 `PRINT-OBJECT` 方法绝对不可以破坏任何 公共介面。

当可以使用单一的 `FORMAT` 字串， 就应该不要使用一系列的 `WRITE-XXX`。 使用 format 允许你参数化控制字串，以备不时之需。

应该使用 `WRITE-CHAR` 来输出一个字符， 而不是 `WRITE-STRING` 来输出单字符的字串。

应该不要使用 `(format nil "~A" value)`； 而是用 `PRINC-TO-STRING` 来取代。

应该在格式化字串里使用 `~<Newline>` 或 `~@<Newline>` 使编辑视窗落在 100 栏， 或将小节或子句缩排，使他们的可读性更高。

应该不要在 format 控制参数里使用 `STRING-UPCASE` 或 `STRING-DOWNCASE`； 应该使用 `"~:@(~A~)"` 或 `"~(~A~)"` 来取代。

使用 `FORMAT` 条件指令时要谨慎。 很容易会忘掉某些参数，参数介绍如下：

没有参数，如 `"~[Siamese~;Manx~;Persian~] Cat"`

接受一个格式化参数，参数应该是一个整数。 使用它来选择一个子句。子句是从零开始算的。 如果数字超出范围，就印出没有就好。 你可以通过在最后一个 `";"` 前印出 `":"` 来提供一个默认值。 比如 `"~[Siamese~;Manx~;Persian~:;Alley~] Cat"` 一个超出范围的参数会印出 `"Alley"`。

`:` 参数，比如 `"~:[Siamese~;Manx~]"`

接受一个参数。如果是 `NIL` 的话使用第一个子句， 不然使用第二个子句。

`@` 参数, 比如 `"~@[Siamese ~a~]"`

如果下个格式化参数为真，使用它但不接受参数。 如果为假，接受一个格式化参数，并印出没有。 （通常子句会使用格式化参数。）

`#` 参数，比如 `"~#[ none~; ~s~; ~s and ~s~]"`

使用参数的数目作为选择子句的数值。 其它与没有参数相同。 下面是个完整的示例： `"Items:~#[ none~; ~S~; ~S and ~S~:;~@{~#[~; and~] ~S~^ ,~}~]."`

## 优化 ##

### 避免配置 ###

[link][link 53] ▽

应该避免配置不必要的内存。

在一个有自动内存管理的语言里（像是 Lisp 或 Java）， 白话的“内存泄漏”指的是，实际上有不需要的内存，却没有被回收， 因为仍然可以访问到这些内存。

创建对象时应该小心， 不要在他们用不到时，仍使它们可以访问。

下列在 Common Lisp 里，一个特别粗心大意的人会中的陷阱。 如果你创建了一个带有填充指针的数组，并在数组里放入对象， 并设置填充指针为 0，那些对象也仍是可访问的 （Common Lisp 规范说在填充指针之后仍可引用到整个数组）。

不要无谓的构造（也就是配置内存）。 垃圾回收不是魔法。 过度的构造通常是一个性能问题。

### 危险操作 ###

[link][link 54] ▽

当有明确的性能需求时，绝对只能使用较快的危险操作， 而你可以记录下来为什么这是对的。

Common Lisp 实现通常提供后门程序，将某些操作用一种不安全的方式快速算出。 举例来说，某些函式库提供算术操作，仅设计给定长术使用， 并在提供正确参数的情况下，较快的给出结果。 这样的风险是这些操作的结果在溢出时是不正确的， 并可能在不是传入定长数时有未定义的行为。

更普遍地说，危险操作会比任何等价的安全操作更快的给出正确结果， 如果参数符合某些约束条件，比如类型正确并够小； 但要是参数不符合这些条件，操作可能会有未定义的行为， 像是使软件崩溃，或者更糟，给出错误的答案。 导航飞机的软件、性命攸关的装置、或是其他负责大量金钱的软件， 这样未定义的行为可能杀人或使人破产。 一定的速度有时可使软件分出高低，但这还不如做对事情的缓慢软件； 做不对事情的软件是净损失，但做对事的缓慢软件却可产生收益。

绝对不要在没有看过评测结果前，就定义或使用危险操作来优化。 并小心记录为什么使用这些危险操作是安全的。 危险操作应限制在内部函数里；应该谨慎记录使用错误参数，来使用这些危险操作有多危险。 应该只在包的内部函数里使用危险操作，并记录声明的用途， 由于使用错误类型的参数，来调用函数会导致未定义的行为。 在一个包导出的函数，使用 `check-type` 来消毒输入参数， 这样内部函数永远不会传入违法的值。

在某些编译器里，新的危险操作通常可通过类型声明及一个 `OPTIMIZE` 声明来定义， 其中声明有着够高的 `SPEED`，以及低的 `SAFETY`。 除了给上线代码提供更多速度外，在那些有类型推论的编译器上， 这样的声明可能比 `check-type` 断言来得更有用，尤其是在编译期找出错误的情况。 如果你将危险操作唤回较安全、较慢的优化设置，带类型推论的编译器可能将这些声明翻译成断言； 能在开发中找出程序里的动态错误，这是件好事，但这不要用在上线的代码， 因为这使的声明的目的不再是一个提升性能的技巧。

### 动态范围 ###

[link][link 55] ▽

应该只在性能很关键时，使用 `DYNAMIC-EXTENT` 而你可以记录下来为什么这是对的。

`DYNAMIC-EXTENT` 声明是一个 [危险操作][Link 5] 的特例。

一个 `DYNAMIC-EXTENT` 声明的目的，是通过当对象的生命周期在函数的动态范围时，减少垃圾回收的次数来改善性能。 这代表对象是在函数调用后的某个时候创建的，并函数存在后用任何方法都访问不到对象。

通过声明一个变量或局部函数 `DYNAMIC-EXTENT`， 程序员告诉 Lisp，他*断定*某个对象会是变量的值，或是函数定义的闭包， 在宣告变量的（最里面那个）函数内有动态范围的生命周期。

Lisp 实现则自由使用这些信息，使得程序运行的更快速。 通常 Lisp 实现可以利用知识来配置栈：

*  创建列表来保存 `&REST` 参数。
 *  在函数内配置结构、向量与列表。
 *  闭包。

如果断言是错误的，也就是说，程序员的声明是错的， 结果可能是场*大灾难*： Lisp 可能在函数返回之后终止，或永远吊在那儿，或 ── 最差的情况 ── 提供一个不正确的结果，确没有任何运行期错误！

即便断言是正确的，未来函数的改动可能引入违反断言的可能。 这提高了危险性。

在多数情况里，这样的对象是短命的。 现代的 Lisp 实现使用新一代的垃圾回收器， 已经可非常高效地处理这些情况。

因此，`DYNAMIC-EXTENT` 声明应节制使用。 必须只在如下情况使用：

1.  有某些好的理由可以支持性能会全面提升，并且
2.  绝对确定断言为真的情况。
3.  通常代码改变后会使声明变成假的情况很少发生。

第一点是避免过早优化的特例。 像这样的优化只对某些频繁配置的对象有效，比如：“在一个内部循环里”。

注意到，判定一个函数不会逃出当前调用的动态范围是很容易的， 可以通过分析函数是在哪被调用的，以及传入的其它函数； 因此，你应该步步惊心的声明一个函数是 `DYNAMIC-EXTENT` 的， 但对这样的声明有太大的压力。 反过来说，要判定对象不会逃出当前调用的动态范围是很难的， 因为无法得知对象在未来函数改动后，会不会被绑定或是被赋给哪个变量。 因此，你应该步步惊心的声明一个变量是 `DYNAMIC-EXTENT` 的。

通常很难知道优化给性能带来多少提升。 当撰写一个是可重用函式库的函数或宏时， 无法未卜先知的知道代码运行的频率。 理想上，会有可用的工具，基于运行模拟的结果，来找出优化的可用性与适用性。 但实际上不是这么简单。 这是一个权衡措施。 如果你非常、非常确定断言为真（对象仅在动态作用域里使用）， 并不知道会多常使用，且不容易测量出来， 则将其声明会比没有声明来得好。 （理想上要做这些测量会比实际来的简单。）

### 应用 x 化简 ###

[link][link 56] ▽

在适当的场合应该使用 `REDUCE` 而不是 `APPLY`。

你应该使用 `REDUCE` 而不是 `APPLY`， 以及一个由构元构造的列表。 当然你必须使用 `APPLY` 如果它办到了你想要的事， 而 `REDUCE` 办不到的时候。举例来说，

;; 差劲
    (apply #'+ (mapcar #'acc frobs))

;; 较佳
    (reduce #'+ frobs :key #'acc :initial-value 0)

这是比较推荐的，因为它没有额外的构造，并没有超出参数限制的危险（用 `CALL-ARGUMENTS-LIMIT` 来查看），在某些实现里限制是很小的，长的列表可能把栈弄垮 （我们想避免代码含有没来由的不可移植性）。

然而当 `REDUCE` 增加了无谓的计算复杂度时，必须小心不要使用 `REDUCE`。 举例来说，`(REDUCE 'STRCAT ...)` 的复杂度为 *O(n^2)*， 在一个适当的实现里仅需要 *O(n)*。 此外，`(REDUCE 'APPEND ...)` 的复杂度也是 *O(n^2)*， 除非你指定从尾端开始（`:FROM-END T`）。 在这些情况里，绝对不要使用 `REDUCE`，也不要用 `(APPLY 'APPEND ...)`。反之必须从合适的函式库挑个正确的抽象来用（可能是你有贡献的函式库），适当地处理这些情况，而不是让用户烦恼实现细节。例子可参见 `UIOP:REDUCE/STRCAT`

### 避免 NCONC ###

[link][link 57] ▽

应该避免使用 `NCONC`； 应该使用 `APPEND` 来取代，或是更好的数据结构。

应该永远不要使用 `NCONC`。 当不依赖任何副作用时，应该使用 `APPEND`。 当需要更新变量时，应该使用 `ALEXANDRIA:APPENDF`。 不要依赖通过 `CDR` 操作当前构元来完成某事（某些人可能会争论说，这只是建议而不是规范）； 而如果你这么做的话，必须附上一个明显的注解， 解释 `NCONC` 的用途； 而你应该重新考虑你呈现数据的方式。

通过扩充，你应该避免 `MAPCAN`， 或 `NCONC` （这里 NCONC 作动词） `LOOP` 的特性。 取而代之的是，应该分别使用 `ALEXANDRIA:MAPPEND` 以及 `APPEND` 来处理 `LOOP` 的特性。

`NCONC` 鲜少是个好想法，由于它的时间与空间复杂度都没有比 `APPEND` 来得好，一般常识下，没有人会共享有副作用的列表， 且它的错误复杂度更是高于 `APPEND`。

如果由于 `APPEND` vs `NCONC` 碰到了性能瓶颈， 这是一个程序的限制因素， 你的问题大了且你可能正使用错误的数据结构： 你应该使用有着常量时间的 append (参见 [Okasaki 的书][Okasaki]，并将它们加入 lisp-interface-library)，或更简单点，你应该用一个树来累积数据， 在累积期完成后，树变扁平，且只会变一次，时间是线性时间。

你只可能在性能重要的底层函数里，使用 `NCONC`、`MAPCAN` 或 `NCONC` `LOOP` 的特性， 其中列表的用途作为一个合法的数据结构，因为这些列表的长度已知是很短的， 且当函数或表达式被累积时，在合约里明确的保证仅返回新的列表（新的列表不可以是常量的引号或反引号表达式）。即使如此，这样子使用原语必须是稀少的，且需要撰写良好的文档。

## 陷阱 ##

### 函数 FUN? 引用 FUN? ###

[link][link 58] ▽

你平时应该使用 `#'FUN` 来引用函数 FUN， 而不是使用 `'FUN`。

前者，念作 `(FUNCTION FUN)`， 指的是函数对象 FUN，并有正确的作用域。 后者，念作 `(QUOTE FUN)`， 指的是符号 FUN，在调用时使用了符号的 `FDEFINITION`。

当使用一个接受函数式参数的函数时（如：`MAPCAR`、`APPLY`、 `:TEST` 以及 `:KEY` 参数）， 你应该使用 `#'` 来引用函数，而不只是单引号。

一个例外是当你明确地想要动态连接时，因为你预期全局函数的绑定会被更新。

另一个例外是当你明确地想要访问一个全局函数的绑定，并避免遮蔽了词法绑定的可能性。 这不应该会常常发生，因为当你想要使用被遮蔽的函数时， 再来遮蔽一个函数，是一个很差的想法； 给词法函数使用另一个名称不就好了。

必须在所有地方一致地使用 `#'(lambda ...)` 或 没有 `#'` 的 `(lambda ...)`。 不像是 `#'symbol` vs `'symbol` 的情形， 这两者只是语法上的差异，不对语义造成影响， 除非前者可在火星上工作，而后者不行。 若你的代码预期要作为，一个兼容所有 Common Lisp 实现的函式库， 你必须使用前者的风格；不然，使用哪个风格取决于你。 `#'`可以理解成一个提示，你正用表达式语境来导入一个函数； 但 `lambda` 本身通常就是足够的提示， 且简洁是好的。 聪明地选择，但综观上述， 与其他的开发者保持一致，在一个同样的文件、包、系统、项目等。

注意，如果你大量使用函数式风格，开始写一个新的系统， 你可能会考虑使用 [lambda-reader][]， 一个让你使用像是 `λ` 字符的系统，而不是写 `LAMBDA`。 但你绝对不要在一个现有的系统里，在没有获得其他开发者的允许下，使用这样的语法扩充。

### 路径名 ###

[link][link 59] ▽

Common Lisp 路径名非常棘手。小心陷阱。使用 `UIOP`。

要正确处理 Common Lisp 的路径名是相当困难的。

`ASDF 3` 带有可移植的函式库 `UIOP` 使得在 Common Lisp 里处理可移植的路径名变得 *非常* 简单。 应该在适当的情况下使用这个库。

首先，注意 Common Lisp 路径名之间的差异， 路径名依赖实现及你正使用的操作系统， 以及系统的原生语法。 Lisp 语法可能牵扯到引用特殊字符，像是 `#\.` 以及 `#\*` 等， 除了字串里 `#\\` 及 `#\"` 的引用之外。 相比之下，系统中的其他语言（Shell, C, 脚本语言）可能 只有一层引用来转成字串。

第二，当使用 `MERGE-PATHNAMES` 时， 注意 `HOST` 组件的处理方式，这对于非 Unix 平台很重要 （甚至是某些 Unix 实现也很重要）。 你应该使用 `UIOP:MERGE-PATHNAMES*` 而不是`MERGE-PATHNAMES`， 特别是若你期望相对路径能像本来在 Unix 或 Windows 里那样工作的话； 不然可能会在某些实现里碰到古怪的错误，将绝对路径与相对路径合并， 造成覆写绝对路径名的 host，且在相对路径名创建时，将 host 换成 `*DEFAULT-PATHNAME-DEFAULTS*` 的值。

第三，留意 `DIRECTORY` 在实现之间是不可移植的， 因为它们处理通配符、子目录、符号链接等，的方式不同 再一次， `UIOP` 提供了许多常见的抽象来处理路径名。

`LOGICAL-PATHNAME`们不是一个可移植的抽象， 并不应在可移植的代码里使用。 许多支援 `LOGICAL-PATHNAME` 的实现，都有错误存在。 SBCL 实现的非常好，但严格限制哪些是标准所允许的字符。 其它实现允许路径名有随意的字符，这么一来就不一致了， 并与其他系统在许多方面不兼容。 你应该使用其它的路径名抽象，像是 `ASDF:SYSTEM-RELATIVE-PATHNAME` 或 背后的 `UIOP:SUBPATHNAME` 与 `UIOP:PARSE-UNIX-NAMESTRING`。

最后，注意可能随时间改变的路径，在你建构 Lisp 映像及运行映像时会改变的路径。 你应该谨慎的重置你的映像，来修正不相关的建构期路径， 以及从当前环境变量来重新初始化任何查找路径。 举例来说 `ASDF` 需要你使用 `ASDF:CLEAR-CONFIGURATION` 来重置路径。 `UIOP` 提供了在 image 导出前的 hook，让你可以将有关变量重置或 `makunbound`。

### 满足 ###

[link][link 60] ▽

在一个类型说明符里使用 `SATISFIES` 必须非常谨慎。

大多数 Common Lisp 实现无法基于一个 `SATISFIES`类型来做优化， 但许多实现提供了简单的优化，基于此形式的类型： `(AND FOO (SATISFIES BAR-P))` 其中 `AND` 子句的第一项描述了对象的结构， 没有使用任何的 `SATISFIES`，而第二项是 `SATISFIES`。

(deftype prime-number () (satisfies prime-number-p)) ; 差劲

(deftype prime-number () (and integer (satisfies prime-number-p)) ; 较佳

然而，在 `DEFTYPE` 语言中的 `AND` 不是一般语言表达式中， 一个从左至右求值的短路操作符。 它是一个对称的连接器，允许重新排序子项，但不保证会有短路。 因此，在上例当中， 你不能依赖检验 `INTEGER` 整数性的测试， 来保护一个非整数的参数传入 `PRIME-NUMBER-P` 函数。 实现可能，且某些*将* 在编译期调用 `SATISFIES` 具体的函数， 来测试相关的对象。

这也是为什么在一个 `SATISFIES` 子句中指定的函数，必须接受任何类型的参数， 且必须在一个 `EVAL-WHEN` 里被定义（以及任何用到的变量或调用的函数）：

(defun prime-number-p (n) ; 非常差！
      (let ((m (abs n)))
        (if (<= m *prime-number-cutoff*)
            (small-prime-number-p m)
            (big-prime-number-p m))))

(eval-when (:compile-toplevel :load-toplevel :execute) ; 较佳
      (defun prime-number-p (n)
        (when (integerp n) ; 较佳
          (let ((m (abs n)))
            (if (<= m *prime-number-cutoff*)
                (small-prime-number-p m)
                (big-prime-number-p m))))))

特别的是，上述说明的代表着这个在 Common Lisp 标准里使用的 [例子][Link 9] 是错误的。 `(and integer (satisfies evenp))` *不是*一个安全的、一致性的类型指定符，当传入非整数作为参数时， `EVENP` 会抛出一个错误，而不是返回 `NIL`。

最后有一个要注意的是，当你的 `DEFTYPE` 代码展开成一个 有着动态产生的函数的 `SATISFIES`时：lly generated function:

*  你不能控制实现会不会展开一个 `DEFTYPE`。
 *  展开本身不能包含一个函数定义，或任何在表达式语言里的代码。
 *  当展开式使用时，你控制不了它， 它可能发生在不同的进程，而进程没有展开它的定义。

你不能使用 `EVAL` 在类型展开期只创建函数，来做为展开式的副作用。 解决办法是使用 `ASDF-FINALIZERS:EVAL-AT-TOPLEVEL` 来取代。 参见我们讨论 [EVAL][] 的最后一点。

Common Lisp 是...很难满足的。

--------------------

致谢： Adam Worrall, Dan Pierson, Matt Marjanovic, Matt Reklaitis, Paul Weiss, Scott McKay, Sundar Narasimhan, 以及其他贡献者。 特别感谢 Steve Hain 以及先前的编辑者， 按时间反序排列，他们是 Dan Weinreb 及 Jeremy Brown。

修订版号 1.23

Robert Brown[François-René Rideau][Fran_ois-Ren_ Rideau]

[Google Common Lisp Style Guide Rev. 1.23]: http://juanitofatas.github.io/Google-Common-Lisp-Style-Guide/GoogleCLSG.xml
[CC-By 3.0]: http://creativecommons.org/licenses/by/3.0/
[Fran_ois-Ren_ Rideau]: mailto:tunes@google.com
[link]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E6%B3%A8%E6%84%8F%EF%BC%9A%E6%98%BE%E7%A4%BA%E5%9C%A8%E6%9C%AC%E6%8C%87%E5%8D%97%E9%87%8C%E6%89%80%E9%9A%90%E8%97%8F%E7%9A%84%E4%BF%A1%E6%81%AF#%E6%B3%A8%E6%84%8F%EF%BC%9A%E6%98%BE%E7%A4%BA%E5%9C%A8%E6%9C%AC%E6%8C%87%E5%8D%97%E9%87%8C%E6%89%80%E9%9A%90%E8%97%8F%E7%9A%84%E4%BF%A1%E6%81%AF
[Practical Common Lisp]: http://www.gigamonkeys.com/book/
[Common Lisp HyperSpec]: http://www.lispworks.com/documentation/HyperSpec/Front/index.htm
[Link 1]: http://norvig.com/luv-slides.ps
[link 1]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%BF%85%E9%A1%BB%E3%80%81%E5%BA%94%E8%AF%A5%E3%80%81%E5%8F%AF%E8%83%BD%E3%80%81%E5%88%AB#%E5%BF%85%E9%A1%BB%E3%80%81%E5%BA%94%E8%AF%A5%E3%80%81%E5%8F%AF%E8%83%BD%E3%80%81%E5%88%AB
[RFC 2119]: http://www.ietf.org/rfc/rfc2119.txt
[link 2]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E8%AE%B8%E5%8F%AF%E4%B8%8E%E8%B0%85%E8%A7%A3#%E8%AE%B8%E5%8F%AF%E4%B8%8E%E8%B0%85%E8%A7%A3
[link 3]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E6%83%AF%E4%BE%8B#%E6%83%AF%E4%BE%8B
[link 4]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%8F%A4%E8%80%81%E4%BB%A3%E7%A0%81#%E5%8F%A4%E8%80%81%E4%BB%A3%E7%A0%81
[link 5]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E6%9C%AA%E6%9D%A5%E8%AE%AE%E9%A2%98#%E6%9C%AA%E6%9D%A5%E8%AE%AE%E9%A2%98
[link 6]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%8E%9F%E5%88%99#%E5%8E%9F%E5%88%99
[link 7]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E4%BC%98%E5%85%88%E7%BA%A7#%E4%BC%98%E5%85%88%E7%BA%A7
[link 8]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E6%9E%B6%E6%9E%84#%E6%9E%B6%E6%9E%84
[link 9]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E4%BD%BF%E7%94%A8%E5%87%BD%E5%BC%8F%E5%BA%93#%E4%BD%BF%E7%94%A8%E5%87%BD%E5%BC%8F%E5%BA%93
[Link 2]: http://zh.wikipedia.org/zh-cn/%E9%9D%9E%E6%88%91%E6%89%80%E5%89%B5
[link 10]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%BC%80%E6%BA%90%E4%BB%A3%E7%A0%81#%E5%BC%80%E6%BA%90%E4%BB%A3%E7%A0%81
[link 11]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%BC%80%E5%8F%91%E8%BF%87%E7%A8%8B#%E5%BC%80%E5%8F%91%E8%BF%87%E7%A8%8B
[link 12]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E6%8B%BC%E5%86%99%E4%B8%8E%E7%BC%A9%E5%86%99#%E6%8B%BC%E5%86%99%E4%B8%8E%E7%BC%A9%E5%86%99
[link 13]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E8%A1%8C%E9%95%BF#%E8%A1%8C%E9%95%BF
[link 14]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E7%BC%A9%E6%8E%92#%E7%BC%A9%E6%8E%92
[link 15]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E6%96%87%E4%BB%B6%E8%A1%A8%E5%A4%B4#%E6%96%87%E4%BB%B6%E8%A1%A8%E5%A4%B4
[Link 3]: http://en.wikipedia.org/wiki/Proprietary_software
[link 16]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%9E%82%E7%9B%B4%E7%A9%BA%E9%97%B4#%E5%9E%82%E7%9B%B4%E7%A9%BA%E9%97%B4
[link 17]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E6%B0%B4%E5%B9%B3%E7%A9%BA%E9%97%B4#%E6%B0%B4%E5%B9%B3%E7%A9%BA%E9%97%B4
[link 18]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E9%92%9C%E7%BB%86%E9%9D%A1%E9%81%97#%E9%92%9C%E7%BB%86%E9%9D%A1%E9%81%97
[link 19]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%88%86%E5%8F%B7%E6%B3%A8%E8%A7%A3#%E5%88%86%E5%8F%B7%E6%B3%A8%E8%A7%A3
[link 20]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E6%A0%87%E7%82%B9%E4%B8%8E%E6%96%87%E6%B3%95#%E6%A0%87%E7%82%B9%E4%B8%8E%E6%96%87%E6%B3%95
[link 21]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%B0%8F%E5%BF%83%E6%B3%A8%E6%84%8F#%E5%B0%8F%E5%BF%83%E6%B3%A8%E6%84%8F
[link 22]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E7%89%B9%E5%AE%9A%E9%A2%86%E5%9F%9F%E8%AF%AD%E8%A8%80#%E7%89%B9%E5%AE%9A%E9%A2%86%E5%9F%9F%E8%AF%AD%E8%A8%80
[link 23]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E7%AC%A6%E5%8F%B7%E5%87%86%E5%88%99#%E7%AC%A6%E5%8F%B7%E5%87%86%E5%88%99
[Link 4]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E6%8B%BC%E5%86%99%E4%B8%8E%E7%BC%A9%E5%86%99
[link 24]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E8%A1%A8%E6%98%8E%E7%9B%AE%E7%9A%84%EF%BC%8C%E8%80%8C%E9%9D%9E%E5%86%85%E5%AE%B9#%E8%A1%A8%E6%98%8E%E7%9B%AE%E7%9A%84%EF%BC%8C%E8%80%8C%E9%9D%9E%E5%86%85%E5%AE%B9
[link 25]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%85%A8%E5%B1%80%E5%8F%98%E9%87%8F%E4%B8%8E%E5%B8%B8%E9%87%8F#%E5%85%A8%E5%B1%80%E5%8F%98%E9%87%8F%E4%B8%8E%E5%B8%B8%E9%87%8F
[link 26]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%88%A4%E6%96%AD%E5%BC%8F%E5%90%8D%E7%A7%B0#%E5%88%A4%E6%96%AD%E5%BC%8F%E5%90%8D%E7%A7%B0
[the CLtL2 chapter on predicates]: http://www.cs.cmu.edu/Groups/AI/html/cltl/clm/node69.html
[link 27]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%BF%BD%E7%95%A5%E5%87%BD%E5%BC%8F%E5%BA%93%E5%89%8D%E7%BC%80#%E5%BF%BD%E7%95%A5%E5%87%BD%E5%BC%8F%E5%BA%93%E5%89%8D%E7%BC%80
[link 28]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%8C%85#%E5%8C%85
[link 29]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E4%BB%A5%E5%87%BD%E6%95%B0%E5%BC%8F%E9%A3%8E%E6%A0%BC%E4%B8%BA%E4%B8%BB#%E4%BB%A5%E5%87%BD%E6%95%B0%E5%BC%8F%E9%A3%8E%E6%A0%BC%E4%B8%BA%E4%B8%BB
[link 30]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E9%80%92%E5%BD%92#%E9%80%92%E5%BD%92
[trampolines]: http://en.wikipedia.org/wiki/Trampoline_%28computing%29#High_Level_Programming
[link 31]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E7%89%B9%E6%AE%8A%E5%8F%98%E9%87%8F#%E7%89%B9%E6%AE%8A%E5%8F%98%E9%87%8F
[link 32]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E8%B5%8B%E5%80%BC#%E8%B5%8B%E5%80%BC
[link 33]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E6%96%AD%E8%A8%80%E4%B8%8E%E6%9D%A1%E4%BB%B6%E5%BC%8F#%E6%96%AD%E8%A8%80%E4%B8%8E%E6%9D%A1%E4%BB%B6%E5%BC%8F
[link 34]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E7%B1%BB%E5%9E%8B%E6%A3%80%E6%9F%A5#%E7%B1%BB%E5%9E%8B%E6%A3%80%E6%9F%A5
[Link 5]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%8D%B1%E9%99%A9%E6%93%8D%E4%BD%9C
[link 35]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=Common_Lisp_%E5%AF%B9%E8%B1%A1%E7%B3%BB%E7%BB%9F#Common_Lisp_%E5%AF%B9%E8%B1%A1%E7%B3%BB%E7%BB%9F
[Interface-Passing Style]: http://common-lisp.net/~frideau/lil-ilc2012/lil-ilc2012.html
[MOP]: http://en.wikipedia.org/wiki/Metaobject#Metaobject_protocol
[link 36]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%AE%8F#%E5%AE%8F
[OAOOM]: http://sbcl-internals.cliki.net/oaoom
[http_random-state.net_log_3390120648.html]: http://random-state.net/log/3390120648.html
[Link 6]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%8A%A8%E6%80%81%E8%8C%83%E5%9B%B4
[link 37]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E4%BD%95%E6%97%B6%E6%B1%82%E5%80%BC#%E4%BD%95%E6%97%B6%E6%B1%82%E5%80%BC
[EVAL-WHEN]: http://fare.livejournal.com/146698.html
[link 38]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E8%AF%BB%E5%8F%96%E6%9C%9F%E6%B1%82%E5%80%BC#%E8%AF%BB%E5%8F%96%E6%9C%9F%E6%B1%82%E5%80%BC
[link 39]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E6%B1%82%E5%80%BC#%E6%B1%82%E5%80%BC
[link 40]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%AF%BC%E5%85%A5%E4%B8%8E%E5%AF%BC%E5%87%BA#%E5%AF%BC%E5%85%A5%E4%B8%8E%E5%AF%BC%E5%87%BA
[link 41]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=NIL:_%E7%A9%BA%E8%A1%A8%E3%80%81%E5%81%87%E3%80%81%E4%BB%A5%E5%8F%8A%E6%88%91%E4%B8%8D%E7%9F%A5%E9%81%93#NIL:_%E7%A9%BA%E8%A1%A8%E3%80%81%E5%81%87%E3%80%81%E4%BB%A5%E5%8F%8A%E6%88%91%E4%B8%8D%E7%9F%A5%E9%81%93
[link 42]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%88%AB%E6%BB%A5%E7%94%A8%E5%88%97%E8%A1%A8#%E5%88%AB%E6%BB%A5%E7%94%A8%E5%88%97%E8%A1%A8
[cl-containers]: http://cliki.net/cl-containers
[lisp-interface-library]: http://cliki.net/lisp-interface-library
[Link 7]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E4%BD%BF%E7%94%A8%E5%87%BD%E5%BC%8F%E5%BA%93
[Link 8]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#%E5%BC%80%E6%BA%90%E4%BB%A3%E7%A0%81
[link 43]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%88%97%E8%A1%A8_x_%E7%BB%93%E6%9E%84_x_%E5%A4%9A%E5%80%BC#%E5%88%97%E8%A1%A8_x_%E7%BB%93%E6%9E%84_x_%E5%A4%9A%E5%80%BC
[link 44]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%88%97%E8%A1%A8_x_%E7%82%B9%E5%AF%B9#%E5%88%97%E8%A1%A8_x_%E7%82%B9%E5%AF%B9
[link 45]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%88%97%E8%A1%A8_x_%E6%95%B0%E7%BB%84#%E5%88%97%E8%A1%A8_x_%E6%95%B0%E7%BB%84
[link 46]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%88%97%E8%A1%A8_x_%E9%9B%86%E5%90%88#%E5%88%97%E8%A1%A8_x_%E9%9B%86%E5%90%88
[link 47]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%AE%9A%E4%B9%89%E5%B8%B8%E9%87%8F#%E5%AE%9A%E4%B9%89%E5%B8%B8%E9%87%8F
[link 48]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%AE%9A%E4%B9%89%E5%87%BD%E6%95%B0#%E5%AE%9A%E4%B9%89%E5%87%BD%E6%95%B0
[link 49]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E6%9D%A1%E4%BB%B6%E8%A1%A8%E8%BE%BE%E5%BC%8F#%E6%9D%A1%E4%BB%B6%E8%A1%A8%E8%BE%BE%E5%BC%8F
[link 50]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%90%8C%E4%B8%80%E6%80%A7_x_%E7%9B%B8%E7%AD%89%E6%80%A7_x_%E6%AF%94%E8%BE%83#%E5%90%8C%E4%B8%80%E6%80%A7_x_%E7%9B%B8%E7%AD%89%E6%80%A7_x_%E6%AF%94%E8%BE%83
[wu-decimal]: http://wukix.com/lisp-decimals
[link 51]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E8%BF%AD%E4%BB%A3#%E8%BF%AD%E4%BB%A3
[link 52]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E8%BE%93%E5%85%A5%E4%B8%8E%E8%BE%93%E5%87%BA#%E8%BE%93%E5%85%A5%E4%B8%8E%E8%BE%93%E5%87%BA
[link 53]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E9%81%BF%E5%85%8D%E9%85%8D%E7%BD%AE#%E9%81%BF%E5%85%8D%E9%85%8D%E7%BD%AE
[link 54]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%8D%B1%E9%99%A9%E6%93%8D%E4%BD%9C#%E5%8D%B1%E9%99%A9%E6%93%8D%E4%BD%9C
[link 55]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%8A%A8%E6%80%81%E8%8C%83%E5%9B%B4#%E5%8A%A8%E6%80%81%E8%8C%83%E5%9B%B4
[link 56]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%BA%94%E7%94%A8_x_%E5%8C%96%E7%AE%80#%E5%BA%94%E7%94%A8_x_%E5%8C%96%E7%AE%80
[link 57]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E9%81%BF%E5%85%8D_NCONC#%E9%81%BF%E5%85%8D_NCONC
[Okasaki]: http://www.amazon.com/Purely-Functional-Structures-Chris-Okasaki/dp/0521663504
[link 58]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E5%87%BD%E6%95%B0_FUN?_%E5%BC%95%E7%94%A8_FUN?#%E5%87%BD%E6%95%B0_FUN?_%E5%BC%95%E7%94%A8_FUN?
[lambda-reader]: http://cliki.net/lambda-reader
[link 59]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E8%B7%AF%E5%BE%84%E5%90%8D#%E8%B7%AF%E5%BE%84%E5%90%8D
[link 60]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml?showone=%E6%BB%A1%E8%B6%B3#%E6%BB%A1%E8%B6%B3
[Link 9]: http://www.lispworks.com/documentation/HyperSpec/Body/t_satisf.htm
[EVAL]: http://lisp.es/Google-Common-Lisp-Style-Guide/GoogleCLSG-zhCN.xml#EVAL