我为我撰写的《第三号行动》小文图书馆撰写自己的文件。
我试图像我那样,保持Adobe Livedocs的布局和内容,同时把它打上一点点。
我认为,我谈到了人们在阅读我的文件时所要知道的一切,但是,在我开始增加我所创造的所有类别之前,我不想错过任何至关重要的东西。
是否有任何人希望获得某种文件? 你们是否认为不必要?
https://projectavian.com
我试图掩盖的一些事情是:
- Easy direct links to documentation sections. ie
/#/class.propertyOrMethod
as above. - Neat tables at the top of the page listing briefly each property, method, constant or whatever other relevant staples are present in the class.
- Clearly separated blocks of information relating to each property or method which can be navigated to directly by the URL in step 1. Clicking the relevant text in the tables at the top of the page will also link down to here.
- Tidy layout for method arguments with concise explanations about each.