javadoc的Stackoverflow標記

過了一段時間，我又回來編寫JavaDoc。與此同時，我越來越喜歡SO的標記，它比HTML更明文。（即使是我以前從未使用過的返回刻度）。javadoc的Stackoverflow標記

/** 
* I'm talking about things like <code>ClassName</code> here. 
* <p> 
* And of course the well known <code>&lt;p&gt;</code>.<br> 
* Should I go on? 
*/

有沒有人在JavaDoc工具鏈中編寫了一些將SO標記轉換爲HTML的過濾器thingy？

或者作爲評論歡迎任何指針如何使用此類功能編寫對JavaDoc的擴展（如果有任何可用，我主要關注接口）。

來源

2011-05-23 vbence

雖然我肯定可以看到有這樣的魅力，我會小心：很多很多的工具假定JavaDoc註釋包含HTML和假設可能會非常棘手關閉。例如，默認情況下Eclipse會通過刪除不重要的空格（對於HTML）來格式化JavaDoc註釋。這會破壞標記。 – 2011-05-23 08:31:31

Javadoc似乎有一個Markdown Doclet，它應該做你想做的。

它由StackOverflow用戶Richard Nichols。他寫了a blog post，其中包括一些示例輸入/輸出的截圖。

來源

2011-05-23 08:20:29

從理查德的原始答案的鏈接，如果有人想投票的話：http://stackoverflow.com/questions/1026553/are-there-some-good-and-modern-alternatives-to-javadoc/ 1043720＃1043720 – 2011-05-23 11:15:04

看起來這個項目已經過時了：/ – 2013-07-24 20:41:46

不幸的是，第一個鏈接現在被打破了，每個鏈接都指向Google Code。 – Adowrath 2017-01-28 21:52:25

MarkdownDoclet有點過時。

對於Java 7，使用https://github.com/Abnaxos/pegdown-doclet

來源

2013-10-22 12:12:13 pron

看來這個項目已經過時了一些：/ – 2015-04-30 18:19:39

這個項目的活動已經回升。 – 2015-06-25 16:15:10

javadoc的Stackoverflow標記

回答

相關問題