.md文件编写规范的资料整理

# .md文件编写规范

MarkdownPad Logo
使用开源项目,都有.md文件,常见于Github网站上创建项目时总会提醒用户创建一个README.md文件。
这篇文章可以作为初学者,理解并使用.md文件的入门资料。

>README 应该是介绍code source 的一个概览。这个静态文件是有约定成俗的规范.

– 你的项目介绍
– 你的代码实现了什么功能?
– 该如何使用? (系统环境参数,部署要素)
– 代码组织架构是什么样的?
– 版本更新重要摘要

>常见普通使用方法<https://en.wikipedia.org/wiki/Markdown>

>语法参考:<http://www.appinn.com/markdown/>

插入本地相对路径图片:
![图片名称alt标签](./images/02.png)

代码示例(此代码不重要,勿视图理解,仅作为演示的格式所用):
———–
<pre>
var myarr = new Array();

myarr[0] = [‘小A’,’女’,21,’大一’];
myarr[1] = [‘小B’,’男’,23,’大三’];
myarr[2] = [‘小C’,’男’,24,’大四’];
myarr[3] = [‘小D’,’女’,21,’大一’];
myarr[4] = [‘小E’,’女’,22,’大四’];
myarr[5] = [‘小F’,’男’,21,’大一’];
myarr[6] = [‘小G’,’女’,22,’大二’];
myarr[7] = [‘小H’,’女’,20,’大三’];
myarr[8] = [‘小I’,’女’,20,’大一’];
myarr[9] = [‘小J’,’男’,20,’大三’];

var i = 0;
var myarr1 = new Array();
for(i=0; i<(myarr.length-1); i++){
if (myarr[i][3]==”大一”&&myarr[i][1]==”女”)
{
document.write(“名字:”+myarr[i][0]+”<br>”);
}
}
</pre>

演示效果如图:

MarkdownPad界面

更多语法可以搜索一下,网上有很多这方面的教程。

MarkDown自带的帮助文件:

编程之路:2个月,可以入门!

平凡之路
平凡之路

经过2个月的学习,完成了1个PHP电子商城的网站。源代码待项目审核后放出!

先记录一些项目过程当中主要的问题:
1、项目节奏(项目启动,项目实施,需求变更,代码完善),好的节奏非常重要,有助于提高开发效率!通过1个项目的练习,逐步发现了知识储备的不完善!毕竟1个人完成1个项目,要求的知识非常全面,这一点需要在项目总结的时候,列出一些知识要点,巩固知识要点。

2、代码冗余。面向过程的开发思维主要是函数的结构化编程,WEB开发的套路熟悉以后,可以多读读好的源码,平时多练习过几个项目,应该是可以逐步的改善代码冗余的问题。

3、代码注释。以往可能会认为代码的注释有时候是一种多余(这原来是一种错觉),但是在项目开发中,由于项目的持续时间比较长,模块之间有不少的关联,大型的项目还涉及到团队成员的合作。好的代码注释,对于阅读源码的人,更加方便理解(有注释可以秒懂,没有注释可能需要前后去分析当时写这段代码的目的是什么),注释的地方主要包含:功能模块,函数说明,补充功能的代码用途。

4、项目经验。首先思路很重要,如果你的思路很清晰,写起来会如鱼多水,可以更加轻松的规划好整个项目,这一点可能需要持久的培养和阅读项目。每一个项目就是很好的锻炼机会,平时就可以多整理好优秀的代码,可以放在下一个项目中。这一点是一个程序的基本功,不是每次等到项目开始的时候,才整理资料。

通过这个WEB开发项目,培养了程序员的思维模式,也开启了心智。下一步如何走,看你自己结合实践吧!后续再来分享。

关于2个月入门,你可以认为一门编程语言,你发一点时间,就可以上手!这就有很多可能性,专注一门,熟练掌握多个技术,只要你努力点,勤奋点!

朴树有首歌曲《平凡之路》,正如”我曾经失落失望失掉所有方向,直到看见平凡才是唯一的答案”这句歌词的意境一样。开启你的编程之路,只要2个月!就这么写着、写着……一直写着,就很美好!

忽然觉得我朝着“会敲代码的伪文艺范”的目标而去了。