无编程基础的人可以通过以下方法做好编程笔记:
代码注释
尽量让代码自解释:好的代码应该具有清晰的结构、合理的命名和简洁的表达,这样即使没有注释,也能让人一目了然。如果需要写很多注释,可能是代码需要重构。
注释应该说明为什么而不是怎么做:代码本身可以告诉你它是怎么做的,但注释应该解释代码背后的逻辑、目标、假设和限制。
避免过度注释:过多的注释会增加代码的复杂度和冗余,降低代码的可读性和可维护性。
保持注释和代码的一致性:如果代码发生变化,注释也应该及时更新,避免过时或错误的注释。
使用标准的注释格式:不同的编程语言或工具有不同的注释规范或风格,例如JavaDoc、Doxygen、Sphinx等,遵循这些规范可以让注释更加规范、统一和易于生成文档。
文档分离
将项目、模块、接口、算法等方面的说明或描述单独写在一个文档中,而不是嵌入在代码中。这样做的好处是可以让文档更加清晰、易于阅读和维护。
记笔记的原则
总纲:记录你觉得有必要的东西,包括概念理解有偏差的、细节没有处理好的、启发性的想法和总结。
分类:将笔记分为需再次强调的内容、已经吸收的内容和大致了解但要实际操作存在一定困难的内容。
整理:将已经牢牢把握吸收的经验复制到所属的章节里,并将好的推进经验放进所属章节后增加书签。定期整理笔记,确保笔记的清晰和有用性。
使用合适的工具
纸质笔记:使用纸质笔记本进行记录,可以提高记忆效果,同时也能更好地理清思路。可以使用不同的颜色笔记、标记重点内容,方便复习和查找。
数字笔记:使用电子设备进行记录,例如使用笔记软件、编程IDE内置的笔记功能。这种方法可以方便地编辑和整理笔记,还可以随时备份和同步到云端。
手写加数字:将手写笔记和数字笔记相结合,例如使用纸质笔记本进行手写记录,然后使用扫描仪或拍照将笔记转为电子格式,再使用笔记软件进行整理和编辑。
建立良好的笔记结构
选择合适的工具:根据个人习惯和偏好选择合适的笔记工具,如纸质笔记本、电子笔记软件等。
建立清晰的分类和标签系统:按照编程语言、算法、数据结构等进行分类,方便后续查找和复习。
使用规范的笔记模板:为每个学习主题创建一个清晰的笔记模板,包括概述、代码示例、解释和说明、注意事项等部分。
保持笔记的更新和整理:及时记录新的学习内容,对已有的笔记进行修订和补充,定期整理和回顾笔记,帮助巩固学习成果。
通过以上方法,无编程基础的人可以逐步建立起自己的编程知识体系,提高编程能力和学习效率。