Skip to content

Commit

Permalink
[zh-tw]: fixed as code review suggested
Browse files Browse the repository at this point in the history
  • Loading branch information
weixiang0815 committed Feb 16, 2025
1 parent b5e2463 commit 3009d53
Showing 1 changed file with 2 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -217,12 +217,13 @@ API 總覽頁面的長度會因 API 規模而異,但基本結構大致相同
5. **屬性與方法列表(List of properties, List of methods)**:這些章節應分別命名為「屬性」與「方法」,並使用 `\\{{domxref}}` 巨集連結至各自參考頁面及提供簡要描述。這些列表應使用[描述/定義列表](/zh-TW/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN#definition_lists) 來標記,每項描述應盡量簡潔(最好為一句話)。你可以參閱「使用 `\\{{domxref}}` 巨集來參照其它 API 功能」章節,以更快速地建立連結至其它頁面。

在列出屬性或方法前,應標示該介面的繼承關係,格式如下(以斜體呈現):

- _此介面未實作任何專屬屬性,但自 `\\{{domxref("XYZ")}}``\\{{domxref("XYZ2")}}` 繼承屬性。_
- _此介面也自 `\\{{domxref("XYZ")}}``\\{{domxref("XYZ2")}}` 繼承屬性。_
- _此介面未實作任何專屬方法,但自 `\\{{domxref("XYZ")}}``\\{{domxref("XYZ2")}}` 繼承方法。_
- _此介面也自 `\\{{domxref("XYZ")}}``\\{{domxref("XYZ2")}}` 繼承方法。_

> [!NOTE]
> [!NOTE]
> 若屬性為唯讀(read-only),則應在 `\\{{domxref}}` 連結的同一行加入 `\\{{ReadOnlyInline}}` 巨集,以生成「唯讀(Read only)」標記。若屬性為實驗性、非標準或已棄用,應先使用 `\\{{experimentalInline}}``\\{{non-standard_Inline}}``\\{{deprecatedInline}}` 巨集進行標記。
6. **範例(Examples)**:提供一段程式碼範例,展示 API 主要功能的典型使用方式。不用列出完整程式碼,只須挑選其中較有價值的部分。若需要完整的程式碼,則可提供 [GitHub](https://github.com/) 倉儲的連結,其中包含完整範例,或使用 [GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site) 功能建立可在線上執行的範例(前提是僅使用客戶端程式碼)。如果範例具有視覺化效果,也可以使用 MDN 的[即時範例](/zh-TW/docs/MDN/Writing_guidelines/Page_structures/Live_samples)(Live Sample)功能,讓程式碼可在頁面上即時執行。
Expand Down

0 comments on commit 3009d53

Please sign in to comment.