1.代碼風格

從VTK繼承的類要保持VTK傳統命名規則。VTK的代碼設計標準參考如下： http://www.vtk.org/Wiki/VTK_Coding_Standards

1.1 命名風格

• 縮寫詞應該用同樣大小的字母表示(全大寫/全小寫)

RASToSlicer RasToSlicer；vtkMRML vtkMrml；vtkSlicer vTKSlicer；

• 單詞應該全拼而不是縮寫

GetWindow GetWin；

• 文件名鼻血采用‘駝峰’慣例

TestMyFeature.c Test_My_Feature.c

• 使用美式英語單詞

Millimeter Millimetre；Color? Colour;

1.2 注釋風格

• 頭文件中注釋全面的注釋信息；
• 當代碼發生改變時應該及時進行標注；
• 需要重新考慮的代碼，應該用關鍵詞‘todo’進行標記；
• 在源代碼文件中盡量不要使用注釋快

1.3 功能風格

• 不要混淆不同層次的抽象

例如，當我們處理文件名和文件路徑的時候，應該使用VTK類中的kwsys::SystemTool、Qt類中的QFileInfo/QDir、或者Python中的os.path。而不是人工進行字符串操作： QString filePath = directoryPath + ''/'' + fileName + ''.exe''; 應該采用： SystemTools::JoinPath();SystemTools::GetFilenameName(); QFileInfo(QDir directorty, QString fileName);QFileInfo::suffix();QFileInfo::absoluteFilePath(); os.path.join();os.path.splitext();os.path.abspath();

• 盡量使用標準模板庫，但是要遵循VTK指南

VTK中如何使用標準模板庫，可以參考如下網址： http://www.vtk.org/Wiki/VTK_FAQ#Can_I_use_STL_with_VTK.3F
注意： 1.在Qt文件中，更提倡應用Qt容器類而不是標準模板庫； 2.vtkCollection和std::list<vtkSmartPointer<vtkObject*>>具有相同的功能。

1.4 語言風格

C++、Python、CMake

1.5 庫依賴風格

• MRML類只依賴vtk和itk（并不依賴Slicer logic和Qt哦）
• 邏輯類Logic依賴MRML存儲狀態
• 邏輯類Logic能夠封裝vtk/itk，實現特定的Slicer任務（例如對體數據重采樣后顯示）
• GUI類依賴MRML、Logic、Qt

1.6 坐標系風格

• 3D世界空間坐標系采用RAS空間坐標系。世界坐標系、解剖坐標系、圖像坐標系如下圖：

• 所有的單位都是毫米millimeter

1.7 錯誤與警告風格

itk/vtk/qt、std::cout、std::cerr......錯誤日志里面所有的錯誤都可以根據他們的類型（debug/warning/error），利用文件過濾器找到。

• Qt:qCritical()、qWarning()、qDebug()

對于Error信息使用qCritical(): if (somethingWrongHappened){qCritical() << "I encountered an error";return;}對于Warning信息使用qWarning(): qWarning() << "Be careful here, this is dangerous";對于Debug信息使用qDebug(): qDebug() << "This variable has the value: "<< value;

• VTK-based：vtkErrorMacro()、vtkWarningMacro()、vtkDebugMacro()

對于Error信息使用vtkErrorMacro(): if (somethingWrongHappened){vtkErrorMacro("I encountered an error");return;}對于Warning信息使用vtkWarningMacro(): vtkWarningMacro("Be careful here, this is dangerous");對于Debug信息使用vtkDebugMacro(): vtkDebugMacro("This variable has the value: "<< value);

2.UI設計準則

2.1 一般準則

• 微軟用戶交互文本準則：https://msdn.microsoft.com/en-us/library/windows/desktop/dn742478.aspx
• 微軟窗體風格和色調指南：https://msdn.microsoft.com/en-us/library/windows/desktop/dn742477.aspx
  

2.2 面板

• Section：

Section用來對參數進行分類。上圖是‘Rendering module’，包含三個sections，‘Input’、‘Display’、‘Advanced...’ 默認的情況下，‘Input’和‘Advanced...’都是折疊的。

• Parameter：

對齊，空間利用合理即可。

2.3 文本

• 首字母大寫；
• 句子壓縮，簡單明了；
• 不要使用冒號 ‘:’
• 使用美式英語，不要使用縮略詞

總結

以上是生活随笔為你收集整理的3DSlicer12：风格准则的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。