因為有時要注釋的東西太多了,如果沒有標記,則沒有層次和重點,則很難弄明白這段代碼到底是幹什麼用的。


我記得曾經 visual studio 有個插件可以在注釋裡面插圖……


因為代碼是plain text,注釋部分也不例外,本身就沒有格式可言。

當然你可以說,我們可以用Doxygen的格式啊,我們可以用markdown格式啊。那問題來了:到底誰說了算?


有啊,Visual Studio

Supercharger


在注釋里寫文檔url就ok了


VSCode 裡面的 TypeScript 注釋好像是支持 Markdown 的。雖然算不上富文本,但是至少能劃分層次,標記重點,甚至還可以貼出帶高亮的示例代碼。


Jupiter notebook 啊


到底是寫代碼還是寫注釋呢?

依稀想起那個要程序員每寫一行代碼就要寫一行注釋的產品經理。。


文學編程。

lhs, org-mode babel, noweb, literate…


eclipse對Java注視就有類似效果啊。有超鏈接,斜體,甚至部分HTML標籤。但是它不是在受注視的方法上渲染 而是在引用方法的時候在提示框上顯示渲染後的效果


你應該努力把代碼寫得不需要注釋。

如果是演算法或者數據結構的問題,應該寫論文或者書,然後在注釋裡面寫參考資料。


推薦閱讀:
相关文章