为什么我的大豆模板缺少soyDocs？

Question

当我尝试编译这个大豆模板时,Plovr引发了一个编译时异常.

// Copyright 2012 David Faux
/**
 * @overview Lays out the home page.
 */

{namespace templates.home}

/*
 * Lays out the home page.
 */
{template .main}
  <h1>Hi! Welcome to my experimental page.</h1>
  <img src="/images/logo.png" alt="" id="homeLogo" />
{/template}

这是引发的错误.

org.plovr.CheckedSoySyntaxException:
template templates.home.main: Not all code is in Soy V2 syntax
(missing SoyDoc for template {template .main}).

为什么我错过了这个模板的大豆文档？

Answer 1

文件结构状态的Closure Templates文档:

在每个模板的前面加上一个解释模板用途的SoyDoc注释,与JavaDoc的风格相同.

JavaDoc注释必须以begin-comment分隔符开头/**,如如何在Doc Comment的格式下为Javadoc工具编写Doc Comments.

上面的模板示例缺少SoyDoc评论中的第二个星号.它应该如下所示:

/**
 * Lays out the home page.
 */
{template .main}
  <h1>Hi! Welcome to my experimental page.</h1>
  <img src="/images/logo.png" alt="" id="homeLogo" />
{/template}

Answer 2

1. 要向cpeisert的答案添加更多内容, 以下三条注释行应以第一列开头,即在所有后续三行之前不应有空格.

   /**
   * Lays out the home page.
   */
   

2. 这些大豆文件评论和大豆代码(即{template .main})中间应该没有空白行

3. {template .main} 也应该从column1开始,即不应该有前面的空格.