Posted By

nerdfiles on 11/11/11


Tagged

css javascript html python


Versions (?)

Commenting


 / Published in: Other
 

  1. # Headers
  2.  
  3. ## Python
  4.  
  5. ### File Header
  6.  
  7. # -*- coding: utf-8 -*-
  8. #
  9. # ======================================= filename.py == #
  10.  
  11. """
  12. ...
  13.  
  14. @project projectname
  15. @contributor handle ([email protected])
  16. @contributor handle ([email protected])
  17. @datetime 11.4.2011.11.56.a
  18. @devlogin admin/password
  19. """
  20.  
  21. ### Alt File Header
  22.  
  23. # -*- coding: utf-8 -*-
  24. #
  25. # mode_indexes.py
  26. #
  27. # ...
  28. #
  29. # @project projectname
  30. #
  31. # =================================================== #
  32.  
  33. ### Long Section Header with Documentation
  34.  
  35. # == CLASS ======================================= #
  36.  
  37. """
  38. @author spinoza
  39. """
  40.  
  41. ### Long Section Header
  42.  
  43. # == IMPORTS ======================================= #
  44.  
  45. ### Subsection Header
  46.  
  47. # == pythonpath inserts == #
  48.  
  49. ### Django
  50.  
  51. #### Large Comment
  52.  
  53. {#
  54.  
  55. This is a large comment.
  56.  
  57. #}
  58.  
  59. ## Templating
  60.  
  61. ### Include Filepaths
  62.  
  63. Helpful for tracing in templates. Wrap in function using general language to toggle visibility, say through `DEBUG_MODE`, etc.
  64.  
  65. <!-- == @src ./themes/themename/header-base.html == -->
  66.  
  67. ## JavaScript
  68.  
  69. @see JsDoc Toolkit (http://code.google.com/p/jsdoc-toolkit/w/list)
  70.  
  71. ## CSS
  72.  
  73. @see cssdoc0.2.22 (http://cssdoc.net/wiki/CssdocDraft)
  74.  
  75. ### Disclaimer
  76.  
  77. Not sure if the following syntactic constructions are consistent w/ or amenable to cssdoc. Consider them proposals.
  78.  
  79. ### File Header
  80.  
  81. /* ====================================== filename.scss ==
  82. *
  83. * Main Stylesheet for domain.com
  84. *
  85. * ...
  86. *
  87. * @package core
  88. *
  89. * == */
  90.  
  91. ### Alt File Header
  92.  
  93. /* ====================================== filename.css ==
  94.  
  95. Main Stylesheet ''
  96.  
  97. ...
  98.  
  99. @version 0.0.1
  100.  
  101. == */
  102.  
  103. ### Long Section Header
  104.  
  105. /* ==
  106. *
  107. * SECTION
  108. *
  109. * ...
  110. *
  111. * @version 0.0.1
  112. *
  113. * ====================================== */
  114.  
  115. ### Alt Long Section Header
  116.  
  117. /* ==
  118.  
  119. SECTION
  120.  
  121. ...
  122.  
  123. @version 0.0.1
  124.  
  125. ====================================== */
  126.  
  127. ### Short Section Header
  128.  
  129. /* == SECTION ====================================== */
  130.  
  131. ### SASS/SCSS Section Header
  132.  
  133. // == SECTION ======================================
  134.  
  135. ### Endings
  136.  
  137. Optional SASS/SCSS endings. In case you nest like a son-of-a-bitch.
  138.  
  139. #### Section, Blank
  140.  
  141. /* ====================================== */
  142.  
  143.  
  144.  
  145. ### Section, Short & Sweet
  146.  
  147. /* == */
  148.  
  149.  
  150.  
  151. ### Section, Alt SASS/SCSS Short & Sweet
  152.  
  153. // ==
  154.  
  155.  
  156.  
  157. #### Section
  158.  
  159. /* == End body._template ====================================== */
  160.  
  161.  
  162.  
  163. #### Section, Alt SASS/SCSS
  164.  
  165. // == End .container.[widget1|widget2].ul.li ======================================
  166.  
  167.  
  168.  
  169. ### Notes
  170.  
  171. #### Alt SASS/SCSS
  172.  
  173. Quick, meaningful notes (or tags) to find codeblocks.
  174.  
  175. // #ie-bug
  176.  
  177. ## HTML
  178.  
  179. ### File Header
  180.  
  181. Usually after `<!DOCTYPE>`.
  182.  
  183. <!-- ======================================= FILE DETAILS ==
  184.  
  185. /**
  186. * Base Template for domain.com
  187. *
  188. * @file base.html
  189. *
  190. * @author
  191. * @designer
  192. * @org
  193. * @copyright [CC INSERT]
  194. * @date 09.25.2011.1.09.p.cst
  195. * @project project-name
  196. */
  197.  
  198. == -->
  199.  
  200. ### Short Section Header
  201.  
  202. <!-- == BEHAVIOR: ANALYTICS ======================================= -->
  203.  
  204. ### Long Section Header
  205.  
  206. <!-- == CONTENT =======================================
  207.  
  208. CONTENT UI
  209.  
  210. Put a website here or something.
  211.  
  212. ======================================================= -->
  213.  
  214. ### Alt Long Section Header
  215.  
  216. <!-- == CONTENT =======================================
  217.  
  218. CONTENT UI
  219.  
  220. Put a website here or something.
  221.  
  222. == -->
  223.  
  224. ### Begin Dev Section
  225.  
  226. I read `@class` and `@id` as doubles for beginnings of sections. The closings are harding to find.
  227.  
  228. ### End Dev Section
  229.  
  230. <!-- End #elem.class.class -->
  231.  
  232. ### Note
  233.  
  234. For finding codeblocks; tagging. Search for `// #...`.
  235.  
  236. <!-- // #fix -->
  237.  
  238. ### Dev Blank Page
  239.  
  240. Usually just before `</body>` and just after `<body>`; consider just after `<!DOCTYPE>` as well.
  241.  
  242. <!--
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253. This section has been intentionally left blank.
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264. -->

Report this snippet  

You need to login to post a comment.