Tại sao tôi lại thiếu soyDocs cho mẫu đậu nành của mình?

Question

Plovr làm tăng ngoại lệ biên dịch khi tôi cố biên dịch mẫu đậu nành này.

// 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} 

Đây là lỗi được nêu ra.

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

Tại sao tôi thiếu tài liệu đậu nành cho mẫu này?

Answer 1

Các tài liệu Đóng Templates cho file structure trạng thái:

trước mỗi mẫu với một lời nhận xét SoyDoc giải thích mục đích của mẫu, trong cùng một phong cách như javadoc.

bình luận javadoc phải bắt đầu với bắt đầu-comment delimiter /** như trong Làm thế nào để Viết Doc Comments for Javadoc Tool dưới Format of a Doc Comment.

Ví dụ mẫu ở trên thiếu dấu hoa thị thứ hai trong nhận xét SoyDoc. Nó sẽ giống như sau:

/** 
* 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. thêm nhiều hơn để cpeisert's answer tất cả sau ba dòng comment nên bắt đầu với cột đầu tiên, ví dụ: không nên có khoảng trắng trước khi tất cả sau ba dòng.

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

2. Không nên có dòng trống ở giữa những đậu nành doc comment và đậu nành mã (ví dụ: {template .main})

3. {template .main} cũng nên bắt đầu từ column1, ví dụ: có nên không trước khoảng trắng.