2013年9月22日 星期日

[分享] coffeeScript comment style

coffeeScript comment style

CoffeeScript 有幾種不同的註解寫法,以下作為介紹讓大家知道一下


know comment in Coffeescript

一行註解,在經過轉譯之後是不會留下任何記錄
#bala bala bala
轉 js 檔案之後
none
多行註解方式,
###
bala
bala
bala
###
轉成 js
/*
 bala
 bala
 bala
 */
而實際上很多 documentation generater 都會有一個共同的開始,就是註解開頭必須要使用
/**
這樣的符號,因此如果透過 coffee 多行註解的方式轉譯還是會出現問題。這邊可以提供其中一種解決方式。
###*
 * bala
 * bala
###
轉成 js 檔案,
/**
 * bala
 * bala
 */
看起來的確就像是我們要的方式,雖然有點蠢,不過也算是一個完整的開始,至少就讓我們先開始動工吧!


api 文件產生器

沒有留言:

張貼留言

Facebook