※ 引述《StubbornLin (Victor)》之铭言： : 我发现除了写程式之外 : 网页的document也是很重要的 : 如果一个网站如果是像抛弃式的产品那样 : 有没有document是没什麽差 : 可是当一个网站如果是长期经营的 : document就很重要 : 虽然说我正在做的某些网页 : 全部是由我一个人去做的 : 但是即使是我自己，也会忘记当时的一些东西 : 更别说是别人，程式的注解是不用说的 : 除此之外还有document要写，当要维护时如果有document可以看 : 就可以更快进入状况，而不是花很多时间在於了解一些有的没有的 : 就拿template来说，我之前写了一两个网页程式 : template的部份都是直接网页做好就套上去 : 但是当这次要写时，我想到一个问题 : 就是...如果我过一阵子回来看 : 我怎麽知道这个template到底有什麽变数可以使用? : 如果说 这个template要交给别人设计 : 他总不可能看我程式码来决定这个页面到底有什麽 : 而光看template也会遗漏一些预留的东西 : 这时，document就派上用场了 : 所以我现在写有输出页面的程式 : 都会写该页面所对应的template的document : 说明有哪些变数可以引用 还有范例 : 也就是说可以直接引入该document来当做template做各种输出的测试 : 除了template，另一个很需要document的地方，我想应该就是database的table了 : 很多时候资料表开一开，经过一段时间再回来看，当初开这些栏位在干麻的 : 这个表在干麻的，很难光从名字就知道，很多情况下非得去翻程式 : 看这些资料是怎样被存取的 : 所以我想请问一下 : 有没有什麽关於网页的document的心得 : 应该怎样写，有什麽需要写 : 还是工具、技巧等等的 : 以上，谢谢 拆成 HTML 显示 DB SQL 跟 程式逻辑 三个部份 如果三者混在一起 除错或者之後要维护都会东找西找.... 所以整页程式.... 先做SQL的取值 再用程式处理SQL的数值 最後用页面显示处理的结果.... 显示页面 表格的部份可以加一些注解帮助页面的排版.... DB SQL 所有的资料库要留 资料字典下来....可能值要列清楚.... 程式逻辑就可以加上范例之类的 说明.... 变数命名的时候可以用型态加上驼峰字表示.... 至少知道他会是处理什麽数值为主.... 再加上排版....应该就差不多了.... 如果你测试案例有写那就更好了.... 浅见.... --

※ 发信站: 批踢踢实业坊(ptt.cc) ◆ From: 140.122.79.73