Commenting Best Practices

Commenting The Jaxara IT Ltd. Mahmudul Haque Azad

Why commenting ,[object Object],[object Object],[object Object]

8 tips for commenting ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

8 tips for commenting (cont.) ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

8 tips for commenting (cont.) ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

Some conventions ,[object Object],[object Object],/// Getting the requested URL string url = HttpContext.Current.Request.Url.ToString();

Some conventions (cont.) ,[object Object],[object Object]

Commenting in Module Header Module Header commenting template

Commenting in Module Header(cont.) ,[object Object]

Routine/function/method level commenting. ,[object Object],[object Object],[object Object]

Routine/function/method level commenting (cont.) ,[object Object]

Routine/function/method level commenting (cont.)

Commenting for Properties ,[object Object]

That’s all…. ,[object Object]

Commenting Best Practices

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Viewers also liked

Viewers also liked (20)

Similar to Commenting Best Practices

Similar to Commenting Best Practices (20)

Commenting Best Practices