內部源代碼文檔 - FIM ++

Question

一個FIM ++程序的結構需要，它以一個字母以特定的方式關閉和代碼作者的名字結束。

Dear Princess Celestia and Stack Exchange and String: A Sample: 
    ... 
Your faithful student, Southpaw Hare! 

按照language specification，關鍵字「您忠實的學生」（包括逗號而不是下面的空間）被用作類定義的結束標記，下面的名字是沒有語法評論影響。在每個文件

，作者是自動包含（如果不嚴格要求），這一事實使我懷疑它是否可以作爲解釋文件類似於Java文檔的形式。換句話說，其他程序或編輯將能夠解析出這個名字並以某種方式使用它。

1. 這種基於內部註釋的文檔的要求是什麼？在這種特定類型的語法中是否有會導致問題的東西？

2. 足夠的關鍵詞正好與主題？對我而言，缺乏使用「你忠實的學生」作爲複數形式（或者可能是「你忠實的」，或者「真正的你」，因爲一個模棱兩可的版本）的能力會讓多個作者看起來很尷尬和不自然看起來像一封自然人文信是其中一個核心設計範例）。

3. 如果創建一個Java文檔的方法被認爲是，那還有什麼其他功能應該包括在內？首先，日期似乎很常見。在信的頂部加上某種形式的日期評論可能會看起來很自然，並不違反設計範例。

由於語言是新的，不熟悉的大多數，老老實實挺傻的，這裏有一些資源來考慮：

Original Release Announcement

October Followup

Answer 1

對不起沒有給出一個的這樣的任何關注我之前！ 我正在開發這門語言，所以我想我對這個答案有很好的把握。

1. 什麼是這種內部基於註釋的文檔 的要求？這種特殊類型的文件中是否有任何可能導致問題的語法 ？

我從來沒有考慮類似的Javadoc自動文檔技術，所以沒有正式的語法爲。我正在編寫的編譯器完全放棄了註釋，所以它不會支持它，但我相信它不會太難。

1. 關鍵字是否足以適合主題？它發生在我 ，缺乏運用能力「您忠實的學生，」一 複數形式（也可能是「你的忠實」或「此致」爲 曖昧的版本）將使上市多個作者一臉尷尬 和不自然的（和看起來像一個天然的小馬寫的信是核心設計範式之一 ）。

在最後一行作者姓名的想法是用於報告的首要作者，所以多位作者以前從未現在建議。但是，Your faithful students,會很好地工作！

1. 如果創建一個Java文檔的方法被認爲是，那還有什麼其他 功能應包括？首先，日期似乎很常見。包括 信函頂部的某種形式的日期評論可能會看起來很自然，並不違反設計範例。

確實！也許一些在報告的底部，像

(Written 2013-04-11) 

希望這有助於你。你也有一些很棒的點子，在這裏！你應該加入團隊！