为什么我的大豆模板缺少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

file structure州的Closure模板文档：

  

使用SoyDoc注释在每个模板之前解释模板的用途，与JavaDoc的风格相同。

JavaDoc注释必须以开头 - 注释分隔符/**开头，如如何为Javadoc工具编写文档注释中的 Format of a Doc Comment 所示

上面的模板示例缺少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's answer添加更多内容，以下三条注释行应以第一列开头，即在所有后续三行之前不应有空格。

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

2. 在这些大豆文档评论和大豆代码（即{template .main}）中间应该没有空行

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