我正在閱讀Photoshop、IlluStrator和InDesign的JavaScript腳本指南。這個API真的很難讀,因為它假設我知道某些速記約定。問題并不局限于這個特定的腳本指南。我可以列舉出幾十個同樣的問題。當我每天24小時不使用代碼時,我想要查找一些內容,并以最基本的形式查看代碼的簡單示例。但通常一開始很難理解。下面是一個例子。我正在查看如何在Photoshop中用JavaScript更改項目的顏色。所以我搜索PDF并找到“填充顏色”。我在文檔里找到了這個:fillPath
([fillColor]
[, mode]
[, opacity]
[, preserveTransparency] [, feather]
[, wholePath] [, antiAlias])當我讀到這篇文章時,乍一看是毫無意義的。為什么有方括號,我怎么知道我不應該在實現中使用它們?為什么括號里有逗號?我知道密碼是什么應從我找到的樣本看,如下所示:myPath.fillPath(myNewColor)如果我沒有看過這個例子,我就永遠不會從API代碼中推測出這個方法在實現時的樣子。還有人指出,此方法的擴展示例可能如下所示:myPath.fillPath(mynewColor, {
mode: RGB,
opacity: .5
})好的。我可以省略隱含的可選參數。很好。但是,我從來不會從API中猜到這一點。所以,有什么神秘的文檔告訴人們如何閱讀API文檔嗎?為什么寫成這樣?假設我有什么先驗知識?為什么它是這樣的,我能做什么來停止對它的懷疑并“得到”它,這樣我就可以更愉快地閱讀和實現下一個API了?那么,為什么API文檔的編寫方式會混淆像我這樣的常年新手/黑客/DIY呢?如何讀取新的API文檔?
- 3 回答
- 0 關注
- 672 瀏覽
添加回答
舉報
0/150
提交
取消