documentation

0熱度

2回答

我有一個用C++編寫的COM SDK，我想爲我的產品創建文檔。據我所知，大多數人可能不會使用C++來與這個COM組件集成，但很多人會這樣做。哪種方法最適合描述API，而不會丟失C++開發人員需要知道的細節。

0熱度

3回答

我正在尋找一種方法來與我人分享一些iPhone SDK源代碼。目標：共享iPhone SDK源代碼，Objective C用XCode編寫。我有一個很好的我想分享的源代碼。我想讓它變得簡單。我希望它有語法突出顯示，通過這個我的意思是着色和格式化理想情況下，它會讓我有一些空間，使其「適合」我的網站。我希望它看起來像我的網站上的另一個頁面，其中的內容是代碼。換句話說，它不應該只是一個文本文件

3熱度

6回答

以編程方式檢索xml文檔註釋

Visual Studio做到這一點;反射器做它;現在我想和:) 我想檢索一些框架組件一些成員（即mscorlib.dll，System.dll等）的XML文檔。我認爲這將涉及：找到了組裝的XML文件，導航到適當命名的子元素，並檢索所需的項目（<summary>，<remarks>等）爲框架程序集保留的XML文件在哪裏？解密XMLDOC命名方案的任何要點？有沒有任何圖書館可以讓這個過程變得

4熱度

5回答

使用案例文檔的詳細級別

我正在努力管理我的項目並在開始時創建Vision/Scope文檔。包含在這個用例圖中。只列出用例確實幫助我充分了解客戶要求的所有要求，並打開了對話。我在想如何詳細的用例應該是。如果我正在創建一個Web應用程序，並且用戶將登錄以查看報告，那麼是否要在用例描述中列出報告中的所有列？如果不是，那麼我何時會記錄這些細節？

2熱度

6回答

文檔 - 寫作風格

我目前正在記錄我們的開發過程，更重要的是爲什麼我們這樣做的一個特定方式。我打算用我在（物理）學位課程中使用的風格寫作，這在許多數學和物理教科書中都很常見，它沿着以下線條：「因此，我們現在看到X是Y ，因爲Z的」 ‘我們可以說，F（X）...’ 這種風格是很自然的我，但它已經引起了一些討論，我想知道是否有理論根據我計劃編寫的方式。風格的名稱（如果有的話）和/或指向維基百科頁面的鏈接應該足以讓懷疑者

5熱度

4回答

當javadoc-comments中有錯誤時，是否可以從javadoc獲取警告？

不留神我可能會忘記描述一些參數或異常拋出（或別的東西）記錄的方法或類等。當是否有可能以這樣的方式運行的javadoc，它提醒我有關文件不全的項目？（我使用的生成文檔ant腳本）

4熱度

7回答

計算機科學/軟件工程領域是否有標準化的引文格式？

維基百科提供a number of citations used in the sciences，但是在計算機科學和軟件工程相關文檔中有哪一個脫穎而出？我最初的猜測是IEEE format，因爲他們有許多與這兩個領域相關的會議和出版物，但我找不到任何明確的。

0熱度

1回答

我在哪裏可以找到關於如何將網站遷移到wep應用程序的分步指南（教程）？

我有一個在VS2008中創建的ASP.NET 2.0網站，我需要將它遷移到一個Web應用程序。到目前爲止我還沒有多少運氣。我如何弄清楚如何做到這一點？

2熱度

2回答

什麼是記錄標準和最佳實踐的最佳平臺？

我正在探索我們的下一個開發平臺。到目前爲止，我選擇了使用MS SQL Server進行持久化的asp.net MVC。我想記錄我的團隊將使用的最佳實踐和標準。在這個過程中，我想了解每個方面，製作一些原型並總結我的結論。即使在我最初的結論之後，如果有人能夠證明更好的方法來做到這一點，我仍然願意改變它。因爲我喜歡從社區獲得一些反饋，所以我認爲將結果公開以供將來參考是公平的。一些方面的欲涵蓋：層分

3熱度

5回答

在代碼中管理大量文本（並支持翻譯）的最佳方式是什麼？

我正在開發一個應用程序，它有很多文本，也可以包含或不包含在每個構建中的不同模塊。對於每個保存的項目，我們會自動生成一個包含所有細節（即該項目中所用算法的描述等）的報告。目前我們將所有文本作爲字符串嵌入到源代碼中，並且我們還通過po和mo文件支持不同的語言。系統的優點是動態生成文檔和報告文件非常簡單。不好的一點是，源代碼中有很多文本是醜陋的，並且格式（即使用html）並不舒服，編輯文本很困難，