Ivan Gretsky Posted January 23, 2017 Share Posted January 23, 2017 Good day! Looking at @ryan's wonderful documentation I am trying to document my code better. Of course the main standard is phpdoc. I think that is what is mostly used in PW core code and almost everywhere in php world. But phpdoc only standardizes commenting only some elements, like variable definitions, classes, methods. As I write a lot of procedural code in template files I need to document code parts which are not supposed to have their DocBlocks by phpdoc standard. So I am looking for recommendations/standards how to write those. I guess there should be some distinction between simple multiline comments and phdoc DocBlocks. Maybe something to consider about IDE integration or something like that. What I found so far is these (seemingly) phpdoc non-compliant comments in new skyscraper profiles, and these Wordpress recomendations. If you got any thought and/or links on the topic, please share! 1 Link to comment Share on other sites More sharing options...
Ivan Gretsky Posted February 15, 2017 Author Share Posted February 15, 2017 I guess writing comment is much more enjoyable in the forums, but not in the code) For now I settled on this syntax for non-phpdoc multiline comments. Without any particular rules on where to write them. /* * Comments here. */ 3 Link to comment Share on other sites More sharing options...
Recommended Posts