AdguardTeam / AdguardTeam/deep-override

Add some code documentation

未關閉
#14 0 則留言 0 個 reaction 已指派 1 人 已被 @theseanl 認領 在 GitHub 檢視
enhancement
主要語言
TypeScript
星號
15
分支
8
PR 合併指標
30 天內沒有已合併 PR

描述

I'd appreciate if you add a comment in the file head describing the logic starting from the entry point (`DeepOverrideHost.addProperty`) and briefly explaining the algorithm.

Something like this:
1. The entry point -- `addProperty`, accepts this and that parameter
2. Then we're building the object state tree for the given path (`buildAbstractStateTree`)
3. Using this tree we're applying the object state and override necessary properties (`applyObjectState`)
4. Etc, etc

This will greatly help the reader to understand the code.

貢獻指南

這個儲存庫沒有索引到貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。