提供標記說明

現在我們準備要瞭解如何新增說明到 Readme 工具的標記。新增標記說明是使用 org.eclipse.ui.ide.markerHelp 延伸點來完成的。這個延伸點允許外掛程式建立說明環境定義 ID 與特定標記類型的關聯性。只有利用標記類型才能限定標記,或進一步利用一或多個屬性值來限定它。Readme 工具宣告多個不同的說明環境定義:

<extension point="org.eclipse.ui.ide.markerHelp"> 
   <markerHelp 
      markerType="org.eclipse.ui.examples.readmetool.readmemarker" 
      helpContextId="org.eclipse.ui.examples.readmetool.marker_example1_context"> 
      <attribute name="org.eclipse.ui.examples.readmetool.id" value= "1234"/> 
   </markerHelp> 
   <markerHelp 
      markerType="org.eclipse.ui.examples.readmetool.readmemarker" 
      helpContextId="org.eclipse.ui.examples.readmetool.marker_example2_context"> 
      <attribute name="org.eclipse.ui.examples.readmetool.level" value= "7"/> 
   </markerHelp> 
   <markerHelp 
      markerType="org.eclipse.ui.examples.readmetool.readmemarker" 
      helpContextId="org.eclipse.ui.examples.readmetool.marker_example3_context"> 
      <attribute name="org.eclipse.ui.examples.readmetool.level" value= "7"/> 
      <attribute name="org.eclipse.ui.examples.readmetool.department" value= "infra"/> 
   </markerHelp> 
   ...

每一個標記說明環境定義為 Readme 標記類型所定義。然而,每一個說明環境定義關聯於不同的屬性值組合。第一個標記說明環境定義為標記 ID 屬性設為 "1234" 所使用。說明環境定義定義在外掛程式的 HelpContexts.xml 檔中:

<context id="marker_example1_context" >
	<description>Readme marker example 1 <b>Help</b> id = 1234 </description>
</context>

非常確定的,當我們選取 Readme 標記 id="1234" 並使用 F1 選取說明時,會看到說明敘述。

有標記說明的作業清單